frost.quick-freeze — frost 0.5.4

quick-byte-defrost clj

(quick-byte-defrost bytes & options)

Reads an object from the given byte array.

The following options can be specified: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺

Passed to function frost.byte-freezer/create-byte-freezer: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :compressed [default = false] Specifies whether compression of the data is used.

:no-wrap               [default = true]
  For compression algorithm :gzip, set to true for GZIP compatible compression

:compression-level     [choices = *9, 0, 1, 2, 3, 4, 5, 6, 7, 8]
  For compression algorithm :gzip, range 0,1-9 (no compression, best speed - best compression)

:compression-algorithm [choices = *:snappy, :gzip]
  Specifies the compression algorithm to use. Snappy is default since it is pretty fast when reading and writing.

:initial-buffer        [default = (* 1024 1024)]
  Initial size of the buffer that is used for writing data.

:max-buffer            [default = (* 128 1024 1024)]
  Maximal size of the buffer that is used for writing data.

Passed to function frost.kryo/default-kryo: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :registration-required [default = true] Determines whether each class of an object to be serialized needs to be registered.

:additional-serializers [default = nil]
  Can be used to specify a list of additional serializers. Format per class is [class serializer id?].

Passed to function frost.kryo/register-default-serializers: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :persistent-meta-data [default = true]

Passed to function frost.kryo/register-serializers: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :persistent-meta-data [default = true]

:analyze               [default = false]
  Determines if the serializers supports analysis via frost.analysis.

:resolve-error-handler [default = nil]
  If a serializer constructor cannot be resolved, this function will be called to provide an alternative serializer constructor.

quick-byte-freeze clj

(quick-byte-freeze obj & options)

Serializes the given object to a byte array.

The following options can be specified: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺

Passed to function frost.byte-freezer/create-byte-freezer: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :compressed [default = false] Specifies whether compression of the data is used.

:no-wrap               [default = true]
  For compression algorithm :gzip, set to true for GZIP compatible compression

:compression-level     [choices = *9, 0, 1, 2, 3, 4, 5, 6, 7, 8]
  For compression algorithm :gzip, range 0,1-9 (no compression, best speed - best compression)

:compression-algorithm [choices = *:snappy, :gzip]
  Specifies the compression algorithm to use. Snappy is default since it is pretty fast when reading and writing.

:initial-buffer        [default = (* 1024 1024)]
  Initial size of the buffer that is used for writing data.

:max-buffer            [default = (* 128 1024 1024)]
  Maximal size of the buffer that is used for writing data.

Passed to function frost.kryo/default-kryo: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :registration-required [default = true] Determines whether each class of an object to be serialized needs to be registered.

:additional-serializers [default = nil]
  Can be used to specify a list of additional serializers. Format per class is [class serializer id?].

Passed to function frost.kryo/register-default-serializers: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :persistent-meta-data [default = true]

Passed to function frost.kryo/register-serializers: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :persistent-meta-data [default = true]

:analyze               [default = false]
  Determines if the serializers supports analysis via frost.analysis.

:resolve-error-handler [default = nil]
  If a serializer constructor cannot be resolved, this function will be called to provide an alternative serializer constructor.

quick-file-copy clj

(quick-file-copy destination-file source-file & options)

Copy the given source file to the specified destination file.

The following options can be specified: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺

:drop [default = nil] Skip the specified number of entries starting at the first.

:filter [default = nil] Copy only entries matching the given predicate.

:take [default = nil] Copy only the specified number of entries (starting at the first not-dropped entry).

Passed to function frost.compression/wrap-compression: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :no-wrap [default = true] For compression algorithm :gzip, set to true for GZIP compatible compression

:compression-level     [choices = *9, 0, 1, 2, 3, 4, 5, 6, 7, 8]
  For compression algorithm :gzip, range 0,1-9 (no compression, best speed - best compression)

:compression-algorithm [choices = *:snappy, :gzip]
  Specifies the compression algorithm to use. Snappy is default since it is pretty fast when reading and writing.

Passed to function frost.file-freezer/create-defroster: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :locking [default = true] Determines whether locking should be use to make the file freezer thread-safe.

:resolve-error-handler [default = nil]
  If a serializer constructor cannot be resolved, this function will be called to provide an alternative serializer constructor.

Passed to function frost.file-freezer/create-freezer: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :compressed [default = true] Specifies whether compression of the data is used.

:file-info  [default = nil]
  Specifies addition information about the file that is stored in the header of the file.

:locking    [default = true]
  Determines whether locking should be use to make the file freezer thread-safe.

Passed to function frost.kryo/create-specified-kryo: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :additional-serializers [default = nil] Can be used to specify a list of additional serializers. Format per class is [class serializer id?].

:registration-required  [default = true]
  Determines whether each class of an object to be serialized needs to be registered.

:default-serializers    [default = true]
  Specifies whether the default serializers for Clojure and Java data are used. You usually want these.

Passed to function frost.kryo/register-default-serializers: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :persistent-meta-data [default = true]

Passed to function frost.kryo/register-serializers: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :persistent-meta-data [default = true]

:analyze               [default = false]
  Determines if the serializers supports analysis via frost.analysis.

:resolve-error-handler [default = nil]
  If a serializer constructor cannot be resolved, this function will be called to provide an alternative serializer constructor.

quick-file-defrost clj

(quick-file-defrost filedesc & options)

Reads the first object from the file with the given file description. The file description can be anything that clojure.java.io/input-stream can handle.

The following options can be specified: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺

:process-fn [default = identity] Instead of the read object the result of the function application to the object is returned.

Passed to function frost.file-freezer/create-defroster: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :locking [default = true] Determines whether locking should be use to make the file freezer thread-safe.

:resolve-error-handler [default = nil]
  If a serializer constructor cannot be resolved, this function will be called to provide an alternative serializer constructor.

quick-file-defrost-coll clj

(quick-file-defrost-coll filedesc & options)

Reads all objects from the file with the given file description. Returns a collection of those objects. The file description can be anything that clojure.java.io/input-stream can handle.

The following options can be specified: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺

:filter-pred [default = (constantly true)] Function that decides whether an object is returned (including process-fn application) or not.

:max-elements [default = nil] Limit the number of elements in the result collection

:process-fn [default = identity] Instead of the read objects the result of the function applications to the objects is returned.

Passed to function frost.file-freezer/create-defroster: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :locking [default = true] Determines whether locking should be use to make the file freezer thread-safe.

:resolve-error-handler [default = nil]
  If a serializer constructor cannot be resolved, this function will be called to provide an alternative serializer constructor.

quick-file-defrost-coll-chunked clj

(quick-file-defrost-coll-chunked filedesc chunk-size & options)

Reads all objects from the file with the given file description. Returns a collection of those objects. The specified function is applied to chunks of objects instead of single objects. The file description can be anything that clojure.java.io/input-stream can handle.

The following options can be specified: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺

:filter-pred [default = (constantly true)] Function that decides whether an object is returned (including process-fn application) or not.

:process-fn [default = identity] Instead of the read objects the result of the function applications to the objects is returned.

Passed to function frost.file-freezer/create-defroster: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :locking [default = true] Determines whether locking should be use to make the file freezer thread-safe.

:resolve-error-handler [default = nil]
  If a serializer constructor cannot be resolved, this function will be called to provide an alternative serializer constructor.

quick-file-defrost-iterate clj

(quick-file-defrost-iterate filedesc process-fn & options)

Applies the given function to all deserialized objects in the file with the given file description. The file description can be anything that clojure.java.io/input-stream can handle.

The following options can be specified: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺

:filter-pred [default = (constantly true)] Function that decides whether the given function is applied to an object.

:max-elements [default = nil]

Passed to function frost.file-freezer/create-defroster: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :locking [default = true] Determines whether locking should be use to make the file freezer thread-safe.

:resolve-error-handler [default = nil]
  If a serializer constructor cannot be resolved, this function will be called to provide an alternative serializer constructor.

quick-file-freeze clj

(quick-file-freeze filename obj & options)

Writes the given object to a file with the given filename overwriting the file in case it already exists.

The following options can be specified: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺

Passed to function frost.compression/wrap-compression: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :no-wrap [default = true] For compression algorithm :gzip, set to true for GZIP compatible compression

:compression-level     [choices = *9, 0, 1, 2, 3, 4, 5, 6, 7, 8]
  For compression algorithm :gzip, range 0,1-9 (no compression, best speed - best compression)

:compression-algorithm [choices = *:snappy, :gzip]
  Specifies the compression algorithm to use. Snappy is default since it is pretty fast when reading and writing.

Passed to function frost.file-freezer/create-freezer: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :compressed [default = true] Specifies whether compression of the data is used.

:file-info  [default = nil]
  Specifies addition information about the file that is stored in the header of the file.

:locking    [default = true]
  Determines whether locking should be use to make the file freezer thread-safe.

Passed to function frost.kryo/create-specified-kryo: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :additional-serializers [default = nil] Can be used to specify a list of additional serializers. Format per class is [class serializer id?].

:registration-required  [default = true]
  Determines whether each class of an object to be serialized needs to be registered.

:default-serializers    [default = true]
  Specifies whether the default serializers for Clojure and Java data are used. You usually want these.

Passed to function frost.kryo/register-default-serializers: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :persistent-meta-data [default = true]

Passed to function frost.kryo/register-serializers: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :persistent-meta-data [default = true]

:analyze               [default = false]
  Determines if the serializers supports analysis via frost.analysis.

:resolve-error-handler [default = nil]
  If a serializer constructor cannot be resolved, this function will be called to provide an alternative serializer constructor.

quick-file-freeze-coll clj

(quick-file-freeze-coll filename coll & options)

Writes the given collection of objects to a file with the given filename overwriting the file in case it already exists. The objects are written to the file consecutively - the collection itself is not stored.

The following options can be specified: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺

Passed to function frost.compression/wrap-compression: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :no-wrap [default = true] For compression algorithm :gzip, set to true for GZIP compatible compression

:compression-level     [choices = *9, 0, 1, 2, 3, 4, 5, 6, 7, 8]
  For compression algorithm :gzip, range 0,1-9 (no compression, best speed - best compression)

:compression-algorithm [choices = *:snappy, :gzip]
  Specifies the compression algorithm to use. Snappy is default since it is pretty fast when reading and writing.

Passed to function frost.file-freezer/create-freezer: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :compressed [default = true] Specifies whether compression of the data is used.

:file-info  [default = nil]
  Specifies addition information about the file that is stored in the header of the file.

:locking    [default = true]
  Determines whether locking should be use to make the file freezer thread-safe.

Passed to function frost.kryo/create-specified-kryo: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :additional-serializers [default = nil] Can be used to specify a list of additional serializers. Format per class is [class serializer id?].

:registration-required  [default = true]
  Determines whether each class of an object to be serialized needs to be registered.

:default-serializers    [default = true]
  Specifies whether the default serializers for Clojure and Java data are used. You usually want these.

Passed to function frost.kryo/register-default-serializers: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :persistent-meta-data [default = true]

Passed to function frost.kryo/register-serializers: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :persistent-meta-data [default = true]

:analyze               [default = false]
  Determines if the serializers supports analysis via frost.analysis.

:resolve-error-handler [default = nil]
  If a serializer constructor cannot be resolved, this function will be called to provide an alternative serializer constructor.

quick-file-header clj

(quick-file-header filedesc & options)

Reads the file header of the file with the given file description. The file description can be anything that clojure.java.io/input-stream can handle.

The following options can be specified: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺

Passed to function frost.file-freezer/create-defroster: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :locking [default = true] Determines whether locking should be use to make the file freezer thread-safe.

:resolve-error-handler [default = nil]
  If a serializer constructor cannot be resolved, this function will be called to provide an alternative serializer constructor.

quick-file-info clj

(quick-file-info filedesc & options)

Reads the user-provided file info of the file with the given file description. The file description can be anything that clojure.java.io/input-stream can handle.

The following options can be specified: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺

Passed to function frost.file-freezer/create-defroster: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :locking [default = true] Determines whether locking should be use to make the file freezer thread-safe.

:resolve-error-handler [default = nil]
  If a serializer constructor cannot be resolved, this function will be called to provide an alternative serializer constructor.

quick-file-reduce clj

(quick-file-reduce filedesc f & options)

Performs a reduce on the given file.

The following options can be specified: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺

:init-value [default = nil] Optional, initial value passed to the reduce operation.

Passed to function frost.file-freezer/create-defroster: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :locking [default = true] Determines whether locking should be use to make the file freezer thread-safe.

:resolve-error-handler [default = nil]
  If a serializer constructor cannot be resolved, this function will be called to provide an alternative serializer constructor.

quick-stream-defrost clj

(quick-stream-defrost input-stream & options)

Reads an object from the given input stream.

The following options can be specified: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺

Passed to function frost.compression/wrap-compression: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :no-wrap [default = true] For compression algorithm :gzip, set to true for GZIP compatible compression

:compression-level     [choices = *9, 0, 1, 2, 3, 4, 5, 6, 7, 8]
  For compression algorithm :gzip, range 0,1-9 (no compression, best speed - best compression)

:compression-algorithm [choices = *:snappy, :gzip]
  Specifies the compression algorithm to use. Snappy is default since it is pretty fast when reading and writing.

Passed to function frost.kryo/create-specified-kryo: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :additional-serializers [default = nil] Can be used to specify a list of additional serializers. Format per class is [class serializer id?].

:registration-required  [default = true]
  Determines whether each class of an object to be serialized needs to be registered.

:default-serializers    [default = true]
  Specifies whether the default serializers for Clojure and Java data are used. You usually want these.

Passed to function frost.kryo/register-default-serializers: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :persistent-meta-data [default = true]

Passed to function frost.kryo/register-serializers: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :persistent-meta-data [default = true]

:analyze               [default = false]
  Determines if the serializers supports analysis via frost.analysis.

:resolve-error-handler [default = nil]
  If a serializer constructor cannot be resolved, this function will be called to provide an alternative serializer constructor.

Passed to function frost.stream-freezer/create-defroster: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :compressed [default = false] Specifies whether compression of the data is used.

:locking    [default = true]
  Determines whether locking should be use to make the stream freezer thread-safe.

quick-stream-freeze clj

(quick-stream-freeze output-stream obj & options)

Serializes the given object to the given output stream.

The following options can be specified: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺

Passed to function frost.compression/wrap-compression: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :no-wrap [default = true] For compression algorithm :gzip, set to true for GZIP compatible compression

:compression-level     [choices = *9, 0, 1, 2, 3, 4, 5, 6, 7, 8]
  For compression algorithm :gzip, range 0,1-9 (no compression, best speed - best compression)

:compression-algorithm [choices = *:snappy, :gzip]
  Specifies the compression algorithm to use. Snappy is default since it is pretty fast when reading and writing.

Passed to function frost.kryo/create-specified-kryo: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :additional-serializers [default = nil] Can be used to specify a list of additional serializers. Format per class is [class serializer id?].

:registration-required  [default = true]
  Determines whether each class of an object to be serialized needs to be registered.

:default-serializers    [default = true]
  Specifies whether the default serializers for Clojure and Java data are used. You usually want these.

Passed to function frost.kryo/register-default-serializers: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :persistent-meta-data [default = true]

Passed to function frost.kryo/register-serializers: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :persistent-meta-data [default = true]

:analyze               [default = false]
  Determines if the serializers supports analysis via frost.analysis.

:resolve-error-handler [default = nil]
  If a serializer constructor cannot be resolved, this function will be called to provide an alternative serializer constructor.

Passed to function frost.stream-freezer/create-freezer: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺ :compressed [default = false] Specifies whether compression of the data is used.

:locking    [default = true]
  Determines whether locking should be use to make the stream freezer thread-safe.

wrap-drop clj

(wrap-drop write-fn n)

wrap-filter clj

(wrap-filter write-fn pred?)

wrap-take clj

(wrap-take write-fn n)