Struct Jeff 

pub struct Jeff<'a> { /* private fields */ }

Copy-on-write representation of jeff programs.

This thin wrapper over the Cap’n Proto-generated code provides a safe interface to load and store jeff files, converting old versions to the current one as needed.

Implementations

impl<'a> Jeff<'a>

pub const VERSION: u32 = 0u32

Current version of the jeff format.

Loading a jeff file with a previous version will automatically upgrade it to this version.

pub fn read_slice(slice: &mut &'a [u8]) -> Result<Self, JeffError>

Read a jeff program from a slice without copying the data.

The data is not copied, but the buffer must outlive the jeff object. After this call, the slice will be advanced to the end of the jeff data.

pub fn read(reader: impl Read) -> Result<Self, JeffError>

Load a jeff program from a reader.

This will consume the reader and copy the data into an internal buffer. For a zero-copy version, use Jeff::read_slice.

For optimal performance, reader should be a buffered reader type.

Trait Implementations

impl<'a> Clone for Jeff<'a>

fn clone(&self) -> Jeff<'a>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for Jeff<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl ReadJeff for Jeff<'_>

fn module(&self) -> Module<'_>

Returns a read-only reference to the capnp jeff module.