Struct StRingBuffer 

pub struct StRingBuffer<const SIZE: usize> { /* private fields */ }

An implementation of StringBuffer using const generics to store its data on the stack.

Implementations

impl<const SIZE: usize> StRingBuffer<SIZE>

pub const fn new() -> Self

Creates a new StRingBuffer on the stack using the const generic size.

Trait Implementations

impl<const SIZE: usize> Clone for StRingBuffer<SIZE>

fn clone(&self) -> StRingBuffer<SIZE>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const SIZE: usize> Debug for StRingBuffer<SIZE>

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

Formats the value using the given formatter.

impl<const SIZE: usize> Display for StRingBuffer<SIZE>

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

Formats the value using the given formatter.

impl<const SIZE: usize> From<[u8; SIZE]> for StRingBuffer<SIZE>

fn from(data: [u8; SIZE]) -> Self

Converts to this type from the input type.

impl<const SIZE: usize> Hash for StRingBuffer<SIZE>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<const SIZE: usize> IntoIterator for StRingBuffer<SIZE>

type Item = char

The type of the elements being iterated over.

type IntoIter = BufferIterator<StRingBuffer<SIZE>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<const SIZE: usize> Ord for StRingBuffer<SIZE>

fn cmp(&self, other: &StRingBuffer<SIZE>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<const SIZE: usize> PartialEq for StRingBuffer<SIZE>

fn eq(&self, other: &StRingBuffer<SIZE>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<const SIZE: usize> PartialOrd for StRingBuffer<SIZE>

fn partial_cmp(&self, other: &StRingBuffer<SIZE>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<const SIZE: usize> StringBuffer for StRingBuffer<SIZE>

fn push_char(&mut self, c: char)

Adds a char to the buffer. Overwrites the start if the buffer is full.

fn pop(&mut self) -> Option<char>

Remove a char from the buffer if one exists. Returns None if the buffer is empty.

fn pop_front(&mut self) -> Option<char>

Remove a char from the front of the buffer if one exists. Returns None if the buffer is empty.

fn try_push_char(&mut self, c: char) -> Result<usize, StringBufferError>

Tries to push the given character into the buffer. Will return Ok(c.bytes_len) if the write succeeded. If there is not enough room for the char or the buffer is full then Err(NotEnoughSpaceForChar) or Err(BufferFull) is returned respectively.

fn push_str(&mut self, s: &str)

Adds a &str to the buffer. Overwrites the start if the buffer is full.

fn try_push_some(&mut self, s: &str) -> Result<usize, StringBufferError>

Will push as many chars as will fit into the existing space of the buffer. Will not overwrite any existing data.

fn as_slices(&self) -> (&str, &str)

Get a reference to the two buffer segments in order.

fn align(&mut self)

Copies data as required to make the head the start of the buffer. This allocates a temporary buffer the size of the smaller &str given by as_slices.

fn align_no_alloc(&mut self)

Aligns the head of the buffer to the start via rotation. Compared to align this function does not allocate any memory; however, it works in O(buffer.len()) time.

fn len(&self) -> usize

Returns the length of this buffer, in bytes, not chars or graphemes

fn is_empty(&self) -> bool

Returns true if there is no data in the buffer.

fn capacity(&self) -> usize

The number of bytes this buffer can hold. Not the number of chars or graphemes.

fn remaining_size(&self) -> usize

Convenience function to return the number of bytes remaining in the buffer before data is overwritten. This is roughly equivalent to self.capacity() - self.len(), but takes into account any padding required along the edge of the buffer.

fn clear(&mut self)

Empties the buffer

fn try_push_all(&mut self, s: &str) -> Result<(), StringBufferError>

Try to push the entire string into the buffer. If the string is too long or the buffer is full then nothing is written and Err(NotEnoughSpaceForStr) or Err(BufferFull) is returned respectively.

fn chars(&self) -> Chain<Chars<'_>, Chars<'_>>

Returns an iterator over the characters in the buffer. This includes both slices, in order, if the buffer is currently split.

impl<const SIZE: usize> Write for StRingBuffer<SIZE>

fn write_str(&mut self, s: &str) -> Result

Writes a string slice into this writer, returning whether the write succeeded.

fn write_char(&mut self, c: char) -> Result

Writes a char into this writer, returning whether the write succeeded.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Glue for usage of the write! macro with implementors of this trait.

impl<const SIZE: usize> Copy for StRingBuffer<SIZE>

impl<const SIZE: usize> Eq for StRingBuffer<SIZE>

impl<const SIZE: usize> StructuralPartialEq for StRingBuffer<SIZE>