Struct xaynet::mask::MaskObjectBuffer

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

A buffer for serialized mask objects.

Implementations

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

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

Creates a new buffer from bytes.

Errors

Fails if the bytes don't conform to the required buffer length for mask objects.

pub fn new_unchecked(bytes: T) -> Self

Creates a new buffer from bytes.

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

Checks if this buffer conforms to the required buffer length for mask objects.

Errors

Fails if the buffer is too small.

pub fn len(&self) -> usize

Gets the expected number of bytes of this buffer wrt to the masking configuration.

Panics

Panics if the serialized masking configuration is invalid.

pub fn numbers(&self) -> usize

Gets the number of serialized mask object elements.

Panics

May panic if this buffer is unchecked.

Panics if the number can't be represented as usize on targets smaller than 32 bits.

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

Gets the serialized masking configuration.

Panics

May panic if this buffer is unchecked.

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

Gets the serialized mask object elements.

Panics

May panic if this buffer is unchecked.

impl<T: AsRef<[u8]> + AsMut<[u8]>> MaskObjectBuffer<T>

pub fn set_numbers(&mut self, value: u32)

Sets the number of serialized mask object elements.

Panics

May panic if this buffer is unchecked.

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

Gets the serialized masking configuration.

Panics

May panic if this buffer is unchecked.

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

Gets the serialized mask object elements.

Panics

May panic if this buffer is unchecked.