Struct FieldReader 

pub struct FieldReader<'a>(/* private fields */);

Reads one storage part’s fields in the order they were packed. Every length is checked against what remains before it is allocated, and FieldReader::finish refuses trailing bytes.

Implementations

impl<'a> FieldReader<'a>

pub fn new(bytes: &'a [u8]) -> Result<Self, Error>

Read a whole storage part, at most MAX_STORAGE bytes.

pub fn u8(&mut self) -> Result<u8, Error>

A u8.

pub fn u16(&mut self) -> Result<u16, Error>

A big-endian u16.

pub fn text(&mut self, field: &'static str) -> Result<String, Error>

A text that is not secret, such as a bucket or folder id.

pub fn secret_text(&mut self, field: &'static str) -> Result<SecretText, Error>

A secret text, such as a key or share token, erased on drop.

pub fn option<T, E: From<Error>>( &mut self, get: impl FnOnce(&mut Self) -> Result<T, E>, ) -> Result<Option<T>, E>

An Option<T>: 0, or 1 and the value’s fields. Any other tag is refused. get may fail with the caller’s own error, such as a value that reads but is not valid.

pub fn finish(self) -> Result<(), Error>

Refuse bytes after the last field.