Struct xaynet_core::message::ChunkBuffer

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

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                id             |           message_id          |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|     flags     |                    reserved                   |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                                                               |
+                       data (variable length)                  +
|                                                               |

• id: ID of the chunk
• message_id: ID of the message this chunk belong to
• flags: currently the only supported flag indicates whether this is the last chunk or not

Implementations

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

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

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

Errors

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

pub fn new_unchecked(bytes: T) -> Self

Returns a ChunkBuffer 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.

pub fn flags(&self) -> Flags

Gets the flags field.

Panics

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

pub fn id(&self) -> u16

Gets the chunk ID field

Panics

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

pub fn message_id(&self) -> u16

Gets the message ID field

Panics

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

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

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

Gets the rest of the message.

Panics

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

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

pub fn set_flags(&mut self, value: Flags)

Sets the flags field.

Panics

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

pub fn set_id(&mut self, value: u16)

Sets the chunk ID field.

Panics

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

pub fn set_message_id(&mut self, value: u16)

Sets the message ID field.

Panics

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

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

Gets a mutable reference to the rest of the message.

Panics

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