Struct dsf_core::wire::Container

pub struct Container<T: AsRef<[u8]>> { /* fields omitted */ }

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

Methods

impl<'a, T: AsRef<[u8]>> 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 protocol_version(&self) -> Kind

pub fn application_id(&self) -> u16

pub fn kind(&self) -> Kind

pub fn flags(&self) -> Flags

pub fn index(&self) -> u16

pub fn data_len(&self) -> usize

pub fn private_options_len(&self) -> usize

pub fn public_options_len(&self) -> usize

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

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

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]

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)

Encode a a higher level base object into a container using the provided buffer This encodes the base object into the buff and constructs a container from this encoded object

Trait Implementations

impl<T: Clone + AsRef<[u8]>> Clone for Container<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: PartialEq + AsRef<[u8]>> PartialEq<Container<T>> for Container<T>

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl<T: Debug + AsRef<[u8]>> Debug for Container<T>

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

Formats the value using the given formatter.

impl<T: AsRef<[u8]>> StructuralPartialEq for Container<T>