Struct Unpacker 

pub struct Unpacker<'b> { /* private fields */ }

Reads a frame. Every read answers None for bytes that aren’t what Packer writes there.

Implementations

impl<'b> Unpacker<'b>

pub fn open(bytes: &'b [u8]) -> Option<Self>

The frame’s body and table found; the root value next.

pub fn at_end(&self) -> bool

Whether the body is read through.

pub fn get_u(&mut self) -> Option<u64>

pub fn get_i(&mut self) -> Option<i64>

pub fn get_bool(&mut self) -> Option<bool>

pub fn get_f64(&mut self) -> Option<f64>

pub fn get_f32(&mut self) -> Option<f32>

pub fn count(&mut self) -> Option<usize>

A list’s count (every value takes a byte at least).

pub fn get_f64s(&mut self) -> Option<Vec<f64>>

pub fn get_uints<T>(&mut self, of: impl Fn(u64) -> Option<T>) -> Option<Vec<T>>

Bit-packed numbers (Packer::put_uints), each made a T by of.

pub fn get_f32s(&mut self) -> Option<Vec<f32>>

pub fn packed_ints(&mut self) -> Option<(usize, u32, &'b [u8])>

A packed list of ints, unread: how many, bits each, their bytes.

pub fn packed_floats(&mut self, wide: bool) -> Option<(usize, bool, &'b [u8])>

A list of floats, unread: how many, whether they’re f32s, their bytes. A list of f64 says whether it’s narrowed (wide); one of f32 always is.

pub fn get_str(&mut self) -> Option<&'b str>

A string, borrowed from the frame: the table read as far as it’s needed.

pub fn get_shared_str(&mut self) -> Option<Arc<str>>

A string as an Arc<str>: one allocation for every time the frame has it.

pub fn get_bytes(&mut self) -> Option<&'b [u8]>

pub fn get_tagged<T: Schema>(&mut self) -> Option<T>

A value held in its binary form (Packer::put_tagged).

pub fn begin(&mut self) -> Option<usize>

A record starts: where it ends.

pub fn list(&mut self) -> Option<(usize, usize)>

A list (Packer::begin_list): how many items, and where it ends.

pub fn skip_to(&mut self, end: usize) -> Option<()>

Steps to end (a list’s), past what’s left of it.

pub fn position(&self) -> usize

Where it’s read up to.

pub fn fork(&self, at: usize) -> Unpacker<'b>

A reader of the same frame from at, with a string cache of its own.

pub fn more(&self, end: usize) -> bool

Whether the record ending at end has more fields.

pub fn leave(&mut self, end: usize) -> Option<()>

The record ending at end is done: fields this reader doesn’t know skipped.