active.codecs.core — de.active-group/active-codecs 0.1.1

codec? clj

(codec? v)

Returns if v is a codec - both an encoder and a decoder.

conditional clj

(conditional c f & args)

Returns a codec for a tuple of values, where the codec for the first one is c and for the second it's (apply f v args) where v is the first value.

decode clj

(decode codec codes)

Decodes the given sequence of codes according to the given codec, returning a decoder-error? or a tuple of [value rest-codes].

decode-full clj

(decode-full codec codes)

Decodes the given sequence of codes according to the given codec, returning the decoded value. Throws if there are unread codes at the end, or too little codes for the codec, or any other problem.

Decoder clj protocol

-decode clj

(-decode this codes)

Must return [value rest-codes] or a decoder-error

decoder-error clj

(decoder-error msg & [data])

decoder-error? clj

(decoder-error? v)

decoder? clj

(decoder? v)

Returns if v is a decoder.

encode clj

(encode codec value)

Encode with given value according to the given codec, returning a sequence of codes.

Encoder clj protocol

-encode clj

(-encode this value)

Must return a sequence of codes representing the given value.

encoder? clj

(encoder? v)

Returns if v is an encoder.

length-prefix clj

(length-prefix length-codec coll-item-codec)

Returns a codec for a sequence of coll-item-codec of any length, where the length is encoded using length-codec and placed before the encoding of the collection items.

record clj

(record key c & more)

Returns a codec for some named elements with different codecs. The encoded value should be a map of the given keys, and the code is a concatenation of the encodings of each item. E.g. the names are not encoded. Example:

(record :a int8 :b uint32)

repeat clj

(repeat n c)

Returns a codec that is a seq of n times the same codec repeated.

seq clj

(seq c & cs)

Returns a codec for a sequence of values, given codecs for each. The codes are concatenated into one.

simple-codec clj

(simple-codec enc dec & args)

Creates a simple codec based on functions (apply enc value args) to encode, and (apply dec codes args) to decode.

simple-decoder clj

(simple-decoder dec & args)

Creates a simple decoder based on (apply dec value args) to encode.

simple-encoder clj

(simple-encoder enc & args)

Creates a simple encoder based on (apply enc value args) to encode.

singleton clj

The codec for the value representing one item of the code itself. This is also some kind of 'identity' codec.

translate clj

(translate c enc dec & args)

Returns a codec like c, but the value encoded by c is (apply f value args) instead, and the decoded value of the returned value is (apply g value args) instead.

try-decode clj

(try-decode codec codes & [error-return])

Tries to decodes the given sequence of codes according to the given codec, returning the decoded value if successfull. Returns error-return, which defaults to nil, if there are unread codes at the end, or too little codes for the codec, or any other problem.