Liking cljdoc? Tell your friends :D

frost.stream-freezer


create-defrosterclj

(create-defroster input-stream & options)

Creates a stream defroster to read data from the given stream. The stream defroster can be created in a thread-safe or non-thread-safe mode.

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

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

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 stream defroster to read data from the given stream.
The stream defroster can be created in a thread-safe or non-thread-safe mode.

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

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

  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.
raw docstring

create-freezerclj

(create-freezer output-stream & options)

Creates a stream freezer to serialize data into the given output stream. The stream freezer can use compression. The stream freezer can be created in a thread-safe or non-thread-safe mode.

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

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

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 stream freezer to serialize data into the given output stream.
The stream freezer can use compression. The stream freezer can be created in a thread-safe or non-thread-safe mode.

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

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

  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.
raw docstring

IDefrostcljprotocol

defrostclj

(defrost this)

Deserialize the next object.

Deserialize the next object.

IFreezecljprotocol

freezeclj

(freeze this obj)

Serialize a given object.

Serialize a given object.

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close