frost.file-freezer
*header-buffer-max*clj
*header-buffer-min*clj
bytes->headerclj
(bytes->header bytes)closeclj
(close x)Closes the given instance of java.io.Closeable.
Closes the given instance of java.io.Closeable.
create-defrosterclj
(create-defroster filedesc & options)Creates a file defroster for the given file description to read data from this file. The file description can be anything that clojure.java.io/input-stream can handle. The file defroster can be created in a thread-safe or non-thread-safe mode.
The following options can be specified: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺
: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.
Creates a file defroster for the given file description to read data from this file.
The file description can be anything that clojure.java.io/input-stream can handle.
The file defroster can be created in a thread-safe or non-thread-safe mode.
The following options can be specified:
⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺
: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.create-freezerclj
(create-freezer filedesc & options)Creates a file freezer for the given filename to serialize data to this file. The file freezer can use compression. The file freezer can be created in a thread-safe or non-thread-safe mode.
The following options can be specified: ⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺
: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.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.
Creates a file freezer for the given filename to serialize data to this file.
The file freezer can use compression. The file freezer can be created in a thread-safe or non-thread-safe mode.
The following options can be specified:
⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺⎺
: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.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.header->bytesclj
(header->bytes header)IDefrostcljprotocol
defrostclj
(defrost this)(defrost this f)Deserialize the next object.
Deserialize the next object.
defrost-collclj
(defrost-coll this)(defrost-coll this f filter-pred)(defrost-coll this f filter-pred max-elements)Deserialize all remaining objects and return them as a sequential collection.
Deserialize all remaining objects and return them as a sequential collection.
defrost-coll-chunkedclj
(defrost-coll-chunked this chunk-size)(defrost-coll-chunked this chunk-size f filter-pred)Deserialize all remaining objects and return them as a sequential collection. Objects are processed in chunks.
Deserialize all remaining objects and return them as a sequential collection. Objects are processed in chunks.
defrost-iterateclj
(defrost-iterate this f filter-pred)(defrost-iterate this f filter-pred max-elements)Apply a function to all remaining deserialized objects.
Apply a function to all remaining deserialized objects.
IFreezecljprotocol
freezeclj
(freeze this obj)Serialize a given object.
Serialize a given object.
freeze-collclj
(freeze-coll this coll)Serialize a given collection of objects.
Serialize a given collection of objects.
IInfocljprotocol
file-headerclj
(file-header this)Returns the file header.
Returns the file header.
file-infoclj
(file-info this)Returns the user-provided file info.
Returns the user-provided file info.
resource-idclj
(resource-id this)Returns the name of the resource (usually file name).
Returns the name of the resource (usually file name).
read-headerclj
(read-header input-stream)usable-serializer-informationclj
(usable-serializer-information header)writable-serializer-informationclj
(writable-serializer-information header)write-headerclj
(write-header output-stream header)cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close