deed.core — com.github.igrishaev/deed-core 0.1.0

->options clj

(->options opts)

Build an Options object out from a map or nil.

-decode clj multimethod

decode clj

(decode decoder)

Decode a single object from the decoder. When no items left, return an instance of EOF object.

decode-from clj

(decode-from src)

(decode-from src options)

Decode a single value from the src source (a file, an input stream, etc).

decode-seq clj

(decode-seq d)

Get a lazy sequence of decoded values out from a Decoder instance.

decode-seq-from clj

(decode-seq-from src)

(decode-seq-from src options)

Encode multiple values from the src source as a vector.

decoder clj

(decoder src)

(decoder src options)

Make a Decoder instance. The src is anything that can be transformed into an InputStream using the io/input-stream function. The options is either a Clojure map or nil.

encode clj

(encode encoder x)

Encode a single object.

encode-seq clj

(encode-seq encoder coll)

Encode a sequence of objects so they can be read one by one later on. Return the number of objects written.

encode-seq-to clj

(encode-seq-to xs out)

(encode-seq-to xs out options)

Encode multiple values into the out destination. Return a number of values written.

encode-seq-to-bytes clj

(encode-seq-to-bytes xs)

(encode-seq-to-bytes xs options)

Encode multiple values into a byte array.

encode-to clj

(encode-to x out)

(encode-to x out options)

Encode a single value into the out destination (a file, a stream, etc).

encode-to-bytes clj

(encode-to-bytes x)

(encode-to-bytes x options)

Encode a single value into a byte array.

encoder clj

(encoder out)

(encoder out options)

Make an Encoder instance. The out is anything that can be transformed into an OutputStream using the io/output-stream function. The options is either a Clojure map or nil.

eof? clj

(eof? x)

True if the object is EOF.

expand-decode clj macro

(expand-decode [OID decoder] & body)

A helper macro to expand decoding logic for a certain numeric code.

Arguments:

• the OID is a Short unique number describing the type;
• the decoder is a symbol bound to the current Decoder instance.

The body must read fields by calling either top-level decode function or low-level .readInteger, .readString, and other methods, and construct the final value out from them.

expand-encode clj macro

(expand-encode [OID Type encoder value] & body)

A helper macro to expand encoding logic for a certain type.

Arguments:

• the OID is a Short unique number describing the type;
• the Type is a class;
• the encoder is a symbol bound to the current Encoder instance;
• the value is a symbol bound to the current instance of class Type.

The body must encode inner fields of the object using ether top-level encode function or by calling the low-level .writeInt, .writeString, and other methods.

gzip-input-stream clj

(gzip-input-stream src)

gzip-output-stream clj

(gzip-output-stream out)

handle-record clj macro

(handle-record OID RecordClass)

Extend both encode & decode logic so they support a custom defrecord class. Specify the custom OID number and the class object.

Usage:

(defrecord MyCustomRecord [id size sku] ...)

(handle-record 0x1234 MyCustomRecord)

header? clj

(header? x)

True if the object is a Header instance.

IEncode clj protocol

-encode clj

(-encode _this encoder)

unsupported? clj

(unsupported? x)

True if the object is Unsupported.

version clj

(version decoder)

Return a version number used in the decoder.

with-decoder clj macro

(with-decoder [bind src options] & body)

Perform the body binding the new Decoder object to the bind symbol. The src object gets coerced to the input stream. Both encoder and the src object get closed afterwards.

with-encoder clj macro

(with-encoder [bind out options] & body)

Perform the body binding the new Encoder object to the bind symbol. The out object gets coerced to the output stream. Both encoder and the out object get closed afterwards.

writeOID clj

(writeOID encoder oid)