Liking cljdoc? Tell your friends :D

sparkplug.kryo

Functions for managing object serialization with Kryo.

To configure a new Kryo instance, this class looks up all resources in directories named sparkplug/kryo/registry/ on the classpath. The files are read in sorted order, one line at a time. Each line should be tab-separated and begin with the desired action:

  • require {{namespace}} Require a namespace to load code or for other side effects.
  • register {{class}} Register the named class with default serialization. The class name may be suffixed with [] pairs to indicate array class types.
  • register {{class}} {{serializer}} Register the named class with the given serializer. The serializer may either be the name of a class to instantiate with the default constructor, or a qualified function var be resolved and called with no arguments to return a Serializer instance.
  • configure {{config-fn}} Resolve the named function and call it on the Kryo instance to directly configure it.

Blank lines or lines beginning with a hash (#) are ignored.

Functions for managing object serialization with Kryo.

To configure a new Kryo instance, this class looks up all resources in
directories named `sparkplug/kryo/registry/` on the classpath. The files are
read in sorted order, one line at a time. Each line should be tab-separated
and begin with the desired action:

- `require        {{namespace}}`
  Require a namespace to load code or for other side effects.
- `register       {{class}}`
  Register the named class with default serialization. The class name may be
  suffixed with `[]` pairs to indicate array class types.
- `register       {{class}}     {{serializer}}`
  Register the named class with the given serializer. The serializer may
  either be the name of a class to instantiate with the default constructor,
  or a qualified function var be resolved and called with no arguments to
  return a `Serializer` instance.
- `configure      {{config-fn}}`
  Resolve the named function and call it on the Kryo instance to directly
  configure it.

Blank lines or lines beginning with a hash (#) are ignored.

bigint-serializer

(bigint-serializer)

Construct a new Kryo serializer for BigInt values.

Construct a new Kryo serializer for BigInt values.
sourceraw docstring

classpath-registries

(classpath-registries)

Return a sequence of registry file maps from the classpath. Returns a sorted sequence with a single entry per distinct config name. Files earlier on the classpath will take precedence.

Return a sequence of registry file maps from the classpath. Returns a sorted
sequence with a single entry per distinct config name. Files earlier on the
classpath will take precedence.
sourceraw docstring

decode

(decode kryo data)

Deserialize the given byte array using the Kryo codec.

Deserialize the given byte array using the Kryo codec.
sourceraw docstring

defserializermacro

(defserializer name-sym class-sym immutable? & body)

Define a new constructor for a Kryo Serializer with the given write and read method implementations.

Define a new constructor for a Kryo Serializer with the given `write` and
`read` method implementations.
sourceraw docstring

encode

(encode kryo obj)

Serialize the given object into a byte arary using the Kryo codec.

Serialize the given object into a byte arary using the Kryo codec.
sourceraw docstring

ident-serializer

(ident-serializer)

Construct a new Kryo serializer for Named values.

Construct a new Kryo serializer for Named values.
sourceraw docstring

initialize

(initialize)

Creates a new Kryo instance and configures it with classpath registry actions.

Creates a new Kryo instance and configures it with classpath registry
actions.
sourceraw docstring

load-configuration

(load-configuration)

Walk the classpath and load configuration actions from all discovered registries. Returns a function which can be called on a Kryo serializer to configure it.

Walk the classpath and load configuration actions from all discovered
registries. Returns a function which can be called on a Kryo serializer to
configure it.
sourceraw docstring

map-serializer

(map-serializer)

Construct a new Kryo serializer for IPersistentMap values.

Construct a new Kryo serializer for IPersistentMap values.
sourceraw docstring

ordered-map-serializer

(ordered-map-serializer)

Construct a new Kryo serializer for PersistentTreeMap values.

Construct a new Kryo serializer for PersistentTreeMap values.
sourceraw docstring

ordered-set-serializer

(ordered-set-serializer)

Construct a new Kryo serializer for PersistentTreeSet values.

Construct a new Kryo serializer for PersistentTreeSet values.
sourceraw docstring

ratio-serializer

(ratio-serializer)

Construct a new Kryo serializer for Ratio values.

Construct a new Kryo serializer for Ratio values.
sourceraw docstring

registry-extension

SparkPlug registry file extension.

SparkPlug registry file extension.
sourceraw docstring

registry-prefix

SparkPlug registry files must be available under this directory path.

SparkPlug registry files must be available under this directory path.
sourceraw docstring

sequence-serializer

(sequence-serializer)

Construct a new Kryo serializer for ISeq values.

Construct a new Kryo serializer for ISeq values.
sourceraw docstring

set-serializer

(set-serializer)

Construct a new Kryo serializer for IPersistentSet values.

Construct a new Kryo serializer for IPersistentSet values.
sourceraw docstring

string-seq-serializer

(string-seq-serializer)

Construct a new Kryo serializer for StringSeq values.

Construct a new Kryo serializer for StringSeq values.
sourceraw docstring

var-serializer

(var-serializer)

Construct a new Kryo serializer for Var values.

Construct a new Kryo serializer for Var values.
sourceraw docstring

vector-serializer

(vector-serializer)

Construct a new Kryo serializer for IPersistentVector values.

Construct a new Kryo serializer for IPersistentVector values.
sourceraw docstring

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

× close