Struct xaynet::message::Sum2Buffer

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

A wrapper around a buffer that contains a Sum2 message.

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

Implementations

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

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

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

Errors

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

pub fn new_unchecked(bytes: T) -> Self

Returns a Sum2Buffer with the given bytes without performing bound checks.

This means that accessing the message fields may panic.

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

Performs bound checks for the various message fields on this buffer.

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

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.

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

Gets a mutable reference to the mask field.

Panics

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

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

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.

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

Gets a reference to the mask field.

Panics

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

Trait Implementations

impl<T: Clone> Clone for Sum2Buffer<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Sum2Buffer<T>

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

Formats the value using the given formatter.

impl<T: Eq> Eq for Sum2Buffer<T>

impl<T: Hash> Hash for Sum2Buffer<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<Sum2Buffer<T>> for Sum2Buffer<T>

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

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

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

This method tests for !=.

impl<T> StructuralEq for Sum2Buffer<T>

impl<T> StructuralPartialEq for Sum2Buffer<T>