clojure.data.fressian — org.clojure/data.fressian 1.1.0

Read/write fressian data. See http://www.edn-format.org/

associative-lookup clj

(associative-lookup o)

Build an ILookup from an associative collection.

begin-closed-list clj

(begin-closed-list writer)

Begin writing a fressianed list. To end the list, call end-list. Used to write sequential data whose size is not known in advance.

begin-open-list clj

(begin-open-list writer)

Advanced. Writes fressian code to begin an open list. An open list can be terminated either by a call to end-list, or by simply closing the stream. Used to write sequential data whose size is not known in advance, in contexts where stream failure can safely be interpreted as end of list.

clojure-read-handlers clj

Standard set of read handlers for Clojure data.

clojure-write-handlers clj

Standard set of write handlers for Clojure data.

create-reader clj

(create-reader in & {:keys [handlers checksum?]})

Create a fressian reader targeting in, which must be compatible with clojure.java.io/input-stream. Handlers must be a map of tag => ReadHandler wrapped in associative-lookup. See clojure-read-handlers for an example.

create-writer clj

(create-writer out & {:keys [handlers]})

Create a fressian writer targeting out. Handlers must be a nested map of type => tag => WriteHandler wrapped with associative-lookup and inheritance-lookup. See clojure-write-handlers for an example.

end-list clj

(end-list writer)

Ends a list begun with begin-closed-list.

field-caching-writer clj

(field-caching-writer cache-pred)

Returns a record writer that caches values for keys matching cache-pred, which is typically specified as a set, e.g. (field-caching-writer #{:color})

FressianReadable clj protocol

to-input-stream clj

(to-input-stream obj)

Implementation detail.

inheritance-lookup clj

(inheritance-lookup lookup)

Returns an inheritance aware lookup based on lookup that will match subclasses as well as exact matches. Will walk inheritance hierarchy once per new type encountered to find the best match, then cache results.

read clj

(read readable & options)

Convenience method for reading a single fressian object. Takes same options as create-reader. Readable can be any type supported by clojure.java.io/input-stream, or a ByteBuffer.

read-object clj

(read-object rdr)

Read a single object from a fressian reader.

tag clj

(tag obj)

Returns the tag if object is a tagged-object, else nil.

tagged-object? clj

(tagged-object? o)

Returns true if o is a tagged object, which will occur when the reader does not recognized a specific type. Use tag and tagged-value to access the contents of a tagged-object.

tagged-value clj

(tagged-value obj)

Returns the value (an Object arrray) wrapped by obj, or nil if obj is not a tagged object.

write clj

(write obj & options)

Convenience method for writing a single object. Returns a byte buffer. Options are the same as for create-reader, with one additional option. If footer? is specified, will write a fressian footer after writing the object.

write-footer clj

(write-footer writer)

write-object clj

(write-object writer obj)

Write a single object to a fressian reader. Returns the reader.