fress.api — fress 0.3.1

*write-utf8-tag* clj/s

->utf8 clj

(->utf8 s)

Positional factory function for class fress.api.utf8.

begin-closed-list clj/s

(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/s

(begin-open-list writer)

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.

byte-stream clj/s

(byte-stream)

create-reader clj/s

(create-reader in & opts)

Create a fressian reader targeting in.

• :handlers is just a map of tag->fn merged with default read handlers
• :checksum? {boolean} :: maintain a checksum for each byte read, validated when footer received. throws when fails. If no footer, has no effect
• :name->map-ctor map of record names to map->Record constructors at runtime {'string-name' map->some-record}
• cljs allows reading from :offset

create-writer clj/s

(create-writer out & opts)

Create a fressian writer targeting out.

• :handlers is just a map of {type {'tag' write-fn}} merged with default write handlers
• :record->name (cljs only) map of record ctor to string-name (the string version of the record's fully resolved symbol)

end-list clj/s

(end-list writer)

Ends a list begun with begin-closed-list.

field-caching-writer clj/s

(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})

flush-to cljs

(flush-to stream out)

(flush-to stream out offset)

fn->read-handler clj

(fn->read-handler f)

fn->write-handler clj

(fn->write-handler f)

private-field clj

(private-field obj name-string)

read clj/s

(read readable & options)

Convenience method for reading a single fressian object. Takes same options as create-reader

read-all clj/s

(read-all in & options)

like read-batch but accepts readables in addition to FressianReaders

read-batch clj/s

(read-batch fin)

Read a fressian reader fully (until eof), returning a (possibly empty) vector of results.

read-handlers clj

(read-handlers)

(read-handlers user-handlers)

merge in user handlers with default-handlers, wrap for fressian lookup

read-object clj/s

(read-object rdr)

Read a single object from a fressian reader.

reset-caches clj/s

(reset-caches writer)

write a signal to the reader to forget established cache codes

tag clj/s

(tag o)

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

tagged-object? clj/s

(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/s

(tagged-value o)

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

utf8-reader clj

(utf8-reader rdr tag _)

cant modify fressian.impl.Codes so using code from client will fail JVM readers must use "utf8" tag.

utf8-writer clj

(utf8-writer w u)

utf8? clj

(utf8? o)

write clj/s

(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 :footer? {bool}, if specified will write a fressian footer after writing the object.

write-footer clj/s

(write-footer writer)

use to seal off a writer with a final byte count & checksum for verification by a reader. Induces EOF

write-handlers clj

(write-handlers)

(write-handlers user-handlers)

merge in user handlers with default-handlers, wrap for fressian lookup

write-object clj/s

(write-object writer o)

(write-object writer o cache?)

Write a single object to a fressian writer.

write-tag clj/s

(write-tag writer tag field-count)

for use in custom write handlers

write-utf8 clj/s

(write-utf8 writer s)

(write-utf8 writer s cache?)

write a string as raw utf-8 bytes