Struct xaynet_core::message::UpdateBuffer

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

A wrapper around a buffer that contains an Update message.

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

Implementations

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

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

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

Errors

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

pub fn new_unchecked(bytes: T) -> Self

Returns an UpdateBuffer 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<'a, T: AsRef<[u8]> + ?Sized> UpdateBuffer<&'a T>

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

Gets the sum signature field.

Panics

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

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

Gets the update signature field.

Panics

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

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

Gets a slice that starts at the beginning of the masked model field.

Panics

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

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

Gets a slice that starts at the beginning of the masked scalar field.

Panics

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

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

Gets a slice that starts at the beginning og the local seed dictionary field.

Panics

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

impl<T: AsRef<[u8]> + AsMut<[u8]>> UpdateBuffer<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 update_signature_mut(&mut self) -> &mut [u8]

Gets a mutable reference to the update signature field.

Panics

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

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

Gets a mutable slice that starts at the beginning of the masked model field.

Panics

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

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

Gets a mutable slice that starts at the beginning of the masked scalar field.

Panics

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

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

Gets a mutable slice that starts at the beginning of the local seed dictionary field.

Panics

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

Trait Implementations

impl<T: Clone> Clone for UpdateBuffer<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for UpdateBuffer<T>

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

Formats the value using the given formatter.