Struct ReceiveBuffer

pub struct ReceiveBuffer<const N: usize> { /* private fields */ }

Implementations

impl<const N: usize> ReceiveBuffer<N>

pub fn new(init_seq_num: u16) -> Self

Returns a new buffer.

pub fn available(&self) -> usize

Returns the number of available bytes remaining in the buffer.

pub fn is_empty(&self) -> bool

Returns true if the buffer is empty.

pub fn init_seq_num(&self) -> u16

Returns the initial sequence number of the buffer.

pub fn was_written(&self, seq_num: u16) -> bool

Returns true if data was already written into the buffer for seq_num.

pub fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Reads data from the buffer into buf, returning the number of bytes read.

pub fn write(&mut self, data: &[u8], seq_num: u16)

Writes data into the buffer at seq_num.

Panics

Panics if data.len() is greater than the amount of available bytes in the buffer and the data for seq_num has not already been written.

pub fn ack_num(&self) -> u16

Returns the last sequence number in a contiguous sequence from the initial sequence number.

pub fn selective_ack(&self) -> Option<SelectiveAck>

Returns a selective ACK based on the sequence of data written into the buffer.

Trait Implementations

impl<const N: usize> Clone for ReceiveBuffer<N>

fn clone(&self) -> ReceiveBuffer<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Debug for ReceiveBuffer<N>

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

Formats the value using the given formatter.