Struct Container

pub struct Container<T: ImmutableData> { /* private fields */ }

Container object provides base field accessors over an arbitrary (mutable or immutable) buffers See https://lab.whitequark.org/notes/2016-12-13/abstracting-over-mutability-in-rust/ for details

Implementations

impl<'a, T: ImmutableData> Container<T>

pub fn from(buff: T) -> (Self, usize)

Create a new container object from an existing buffer This parses the header and splits the data into fields to simplify access

pub fn header(&self) -> WireHeader<&[u8]>

Fetch wire header

pub fn id(&self) -> &[u8]

Fetch object ID

pub fn body(&self) -> &[u8]

Return the body of data

pub fn private_options(&self) -> &[u8]

Return the private options section data

pub fn public_options(&self) -> impl Iterator<Item = Options> + '_

Return the public options section data

pub fn signed(&self) -> &[u8]

Return the signed portion of the message for signing or verification

pub fn signature(&self) -> &[u8]

Return the signature portion of the message for verification

pub fn len(&self) -> usize

Return the total length of the object (from the header)

pub fn verify<V, E>(&self, verifier: V) -> Result<bool, E>

where V: FnMut(&Id, &Signature, &[u8]) -> Result<bool, E>,

Verify the contents of a given container This calls the provided verifier with the id, body, and signature and forwards the result to the caller

pub fn raw(&self) -> &[u8]

Fetch the raw data using internal header length

impl<'a, T: AsRef<[u8]>> Container<T>

pub fn parse<P, S>( data: T, pub_key_s: P, sec_key_s: S, ) -> Result<(Base, usize), BaseError>

where P: FnMut(&Id) -> Option<PublicKey>, S: FnMut(&Id) -> Option<SecretKey>,

Parses a data array into a base object using the pub_key and sec_key functions to locate keys for validation and decyption

impl<'a, T: AsRef<[u8]> + AsMut<[u8]>> Container<T>

pub fn encode( buff: T, base: &Base, signing_key: &PrivateKey, encryption_key: Option<&SecretKey>, ) -> (Self, usize)

Trait Implementations

impl<T: Clone + ImmutableData> Clone for Container<T>

fn clone(&self) -> Container<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + ImmutableData> Debug for Container<T>

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

Formats the value using the given formatter.

impl<T: PartialEq + ImmutableData> PartialEq for Container<T>

fn eq(&self, other: &Container<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: ImmutableData> StructuralPartialEq for Container<T>