frost.byte-freezer — frost 0.5.4

create-byte-freezer clj

(create-byte-freezer & options)

Creates a byte freezer that can be used to write objects to byte arrays and read them back again. The byte freezer can use compression. The size of its byte buffer can be constrained.

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

:compressed [default = false] Specifies whether compression of the data is used.

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

: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)

: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.

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

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.

IByteFreezer clj protocol

defrost clj

(defrost this obj-bytes)

Defrosts the object from the given bytes

freeze clj

(freeze this obj)

Freezes the given object to bytes.