Struct anchor::FifoBuffer

pub struct FifoBuffer<const BUF_SIZE: usize> { /* private fields */ }

FIFO buffer

This implements a simple FIFO buffer which can be useful when managing data to/from Anchor protocol handling. Using this is completely optional, it is provided as a convenience.

Implementations

impl<const BUF_SIZE: usize> FifoBuffer<BUF_SIZE>

pub const fn new() -> Self

Creates a new buffer

This is declared const, allowing it to be used even in static const contexts.

pub fn is_empty(&self) -> bool

Checks for buffer emptiness

pub fn len(&self) -> usize

Return length of currently stored buffer

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

Return mutable slice to the non-filled part of the buffer

pub fn extend(&mut self, buf: &[u8])

Append buf to the non-filled part of the buffer

Any excess will be discarded.

pub fn advance(&mut self, n: usize)

Moves the used cursor forward

This can be used after filling part of the non-filled buffer returned by receive_buffer.

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

Returns the filled part of the buffer

pub fn pop(&mut self, n: usize)

Removes n bytes from the front of the buffer

This operation moves the used part of the buffer down in memory. This is linear in the number of bytes currently stored.