Crate tycho

Tycho Binary Format

The tycho binary format is a minimal, self-describing and traversable data format designed around rust and the serde data model.

Features

• partial - Partial Reading/Traversal
• serde_support - Serde serialisation and deserialisation
• serde_optimise - Serde structure optimisation (default)
• async_tokio - Async reading support with tokio
• compression - Compression (gzip)

Modules

collections	Wrappers around HashMap and Vec mapping to a respective type within tycho.
compression	Utility traits for element compression/decompression. (requires compression feature)
error	Error types returned from tycho marshall/unmarshall/serialise/deserialize processes.
ident	Type prefixes/identities used within the marshall and unmarshall processes - Returned in errors.
partial	Partial unmarshall and traversal. (requires partial feature)

Enums

Element	A element tag, used to build tycho data structures.
Number	A numerical value tag, used when creating tycho data.
Value	A primitive terminating type, used when creating tycho data.

Traits

Ident	Trait for converting a value or element into an Ident.
ValueType	Identities for a value.

Functions

from_bytes	Deserialize tycho bytes into a serde deserializable object. (requires serde_support)
from_element	Deserialize an element into a serde deserializable object. (requires serde_support)
marshall	Marshall an element to a byte buffer or writable object.
marshall_vec	Marshall an element into a vec of bytes.
to_bytes	Serialize a serde serializable object into tycho bytes. (requires serde_support)
to_element	Serialize a serde serializable object into an Element. (requires serde_support)
unmarshall	Unmarshall an element from a readable object.
unmarshall_async	Unmarshall an element from a async readable object.
unmarshall_vec	Unmarshall an element from a vec of bytes.