<html><head><linkhref="css/default.css"rel="stylesheet"type="text/css"><scriptsrc="js/jquery.min.js"type="text/javascript"></script><scriptsrc="js/page_effects.js"type="text/javascript"></script><title>taoensso.nippy.tools documentation</title></head><body><divid="header"><h2>Generated by <ahref="https://github.com/weavejester/codox">Codox</a></h2><h1><ahref="index.html">Nippy 2.2.0-RC1 API documentation</a></h1></div><divclass="sidebar"id="namespaces"><h3><span>Namespaces</span></h3><ul><li><ahref="taoensso.nippy.html"><span>taoensso.nippy</span></a></li><li><ahref="taoensso.nippy.benchmarks.html"><span>taoensso.nippy.benchmarks</span></a></li><li><ahref="taoensso.nippy.compression.html"><span>taoensso.nippy.compression</span></a></li><li><ahref="taoensso.nippy.encryption.html"><span>taoensso.nippy.encryption</span></a></li><liclass="current"><ahref="taoensso.nippy.tools.html"><span>taoensso.nippy.tools</span></a></li><li><ahref="taoensso.nippy.utils.html"><span>taoensso.nippy.utils</span></a></li></ul></div><divclass="sidebar"id="vars"><h3>Public Vars</h3><ul><li><ahref="taoensso.nippy.tools.html#var--%3EEncryptedFrozen"><span>->EncryptedFrozen</span></a></li><li><ahref="taoensso.nippy.tools.html#var--%3EWrappedForFreezing"><span>->WrappedForFreezing</span></a></li><li><ahref="taoensso.nippy.tools.html#var-freeze"><span>freeze</span></a></li><li><ahref="taoensso.nippy.tools.html#var-map-%3EEncryptedFrozen"><span>map->EncryptedFrozen</span></a></li><li><ahref="taoensso.nippy.tools.html#var-map-%3EWrappedForFreezing"><span>map->WrappedForFreezing</span></a></li><li><ahref="taoensso.nippy.tools.html#var-thaw"><span>thaw</span></a></li><li><ahref="taoensso.nippy.tools.html#var-with-thaw-opts"><span>with-thaw-opts</span></a></li><li><ahref="taoensso.nippy.tools.html#var-wrap-for-freezing"><span>wrap-for-freezing</span></a></li></ul></div><divclass="namespace-docs"id="content"><h2>taoensso.nippy.tools documentation</h2><preclass="doc">Alpha - subject to change.
Utilities for third-party tools that want to add fully-user-configurable Nippy
support. Used by Carmine and Faraday.</pre><divclass="public"id="var--%3EEncryptedFrozen"><h3>->EncryptedFrozen</h3><divclass="usage"><code>(->EncryptedFrozen ba)</code></div><preclass="doc">Positional factory function for class taoensso.nippy.tools.EncryptedFrozen.
</pre></div><divclass="public"id="var--%3EWrappedForFreezing"><h3>->WrappedForFreezing</h3><divclass="usage"><code>(->WrappedForFreezing value opts)</code></div><preclass="doc">Positional factory function for class taoensso.nippy.tools.WrappedForFreezing.
</pre></div><divclass="public"id="var-freeze"><h3>freeze</h3><divclass="usage"><code>(freeze x & [{:keys [default-opts]}])</code></div><preclass="doc">Like `nippy/freeze` but takes options from special argument wrapper when
present.</pre></div><divclass="public"id="var-map-%3EEncryptedFrozen"><h3>map->EncryptedFrozen</h3><divclass="usage"><code>(map->EncryptedFrozen m__5665__auto__)</code></div><preclass="doc">Factory function for class taoensso.nippy.tools.EncryptedFrozen, taking a map of keywords to field values.
</pre></div><divclass="public"id="var-map-%3EWrappedForFreezing"><h3>map->WrappedForFreezing</h3><divclass="usage"><code>(map->WrappedForFreezing m__5665__auto__)</code></div><preclass="doc">Factory function for class taoensso.nippy.tools.WrappedForFreezing, taking a map of keywords to field values.
</pre></div><divclass="public"id="var-thaw"><h3>thaw</h3><divclass="usage"><code>(thaw ba & {:keys [default-opts]})</code></div><preclass="doc">Like `nippy/thaw` but takes options from *thaw-opts* binding, and wraps
encrypted bytes for easy identification when no password has been provided
for decryption.</pre></div><divclass="public"id="var-with-thaw-opts"><h3>with-thaw-opts</h3><h4class="macro">macro</h4><divclass="usage"><code>(with-thaw-opts opts & body)</code></div><preclass="doc">Evaluates body using given options for any automatic deserialization in
context.</pre></div><divclass="public"id="var-wrap-for-freezing"><h3>wrap-for-freezing</h3><divclass="usage"><code>(wrap-for-freezing value & [opts])</code></div><preclass="doc">Wraps arg (any freezable data type) so that (tools/freeze <wrapped-arg>)
will serialize the arg using given options.</pre></div></div></body></html>
