Struct xaynet::message::SumBuffer

pub struct SumBuffer<T> { /* fields omitted */ }

A wrapper around a buffer that contains a Sum message.

It provides getters and setters to access the different fields of the message safely.

Examples

Decoding a sum message

let sum_signature = vec![0x11; 64];
let ephm_pk = vec![0x22; 32];
let bytes = [sum_signature.as_slice(), ephm_pk.as_slice()].concat();
let buffer = SumBuffer::new(&bytes).unwrap();
assert_eq!(buffer.sum_signature(), sum_signature.as_slice());
assert_eq!(buffer.ephm_pk(), ephm_pk.as_slice());

Encoding a sum message

let sum_signature = vec![0x11; 64];
let ephm_pk = vec![0x22; 32];
let mut storage = vec![0xff; 96];
let mut buffer = SumBuffer::new_unchecked(&mut storage);
buffer
    .sum_signature_mut()
    .copy_from_slice(&sum_signature[..]);
buffer.ephm_pk_mut().copy_from_slice(&ephm_pk[..]);
assert_eq!(&storage[..64], sum_signature.as_slice());
assert_eq!(&storage[64..], ephm_pk.as_slice());

Implementations

impl<T: AsRef<[u8]>> SumBuffer<T>

pub fn new(bytes: T) -> Result<Self, DecodeError>

Performs bound checks for the various message fields on bytes and returns a new SumBuffer.

Errors

Fails if the bytes are smaller than a minimal-sized sum message buffer.

pub fn new_unchecked(bytes: T) -> Self

Returns a SumBuffer without performing any bound checks.

This means accessing the various fields may panic if the data is invalid.

pub fn check_buffer_length(&self) -> Result<(), DecodeError>

Performs bound checks to ensure the fields can be accessed without panicking.

impl<T: AsMut<[u8]>> SumBuffer<T>

pub fn ephm_pk_mut(&mut self) -> &mut [u8]

Gets a mutable reference to the sum participant ephemeral public key field.

Panics

Accessing the field may panic if the buffer has not been checked before.

pub fn sum_signature_mut(&mut self) -> &mut [u8]

Gets a mutable reference to the sum signature field.

Panics

Accessing the field may panic if the buffer has not been checked before.

impl<'a, T: AsRef<[u8]> + ?Sized> SumBuffer<&'a T>

pub fn ephm_pk(&self) -> &'a [u8]

Gets a reference to the sum participant ephemeral public key field.

Panics

Accessing the field may panic if the buffer has not been checked before.

pub fn sum_signature(&self) -> &'a [u8]

Gets a reference to the sum signature field.

Panics

Accessing the field may panic if the buffer has not been checked before.

Trait Implementations

impl<T: Clone> Clone for SumBuffer<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for SumBuffer<T>

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

Formats the value using the given formatter.

impl<T: Eq> Eq for SumBuffer<T>

impl<T: Hash> Hash for SumBuffer<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<T: PartialEq> PartialEq<SumBuffer<T>> for SumBuffer<T>

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

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

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

This method tests for !=.

impl<T> StructuralEq for SumBuffer<T>

impl<T> StructuralPartialEq for SumBuffer<T>