Struct BufferViewExample 

pub struct BufferViewExample<'a, T, S> { /* private fields */ }

Available on crate features _docs_examples only.

✨ 🗃️ A linear buffer view over contiguous storage, made with buffer_linear!.

---

^{📍 data/layout}

---

Methods

• common methods

  • Size: len (_prim), is_empty.

• Exclusive slice (slice_mut)

  • Constructors: try_new, new_truncated try_from_slice, from_slice_with, from_slice_truncated.
  • Capacity: capacity (_prim), remaining_capacity (_prim), is_full.
  • Logical range control: clear, truncate, (_prim).
  • Push: push_back (_copy), push_slice (_copy, _copy_exact).
  • Pop: pop_back_clone, pop_back_copy.
  • Peek: peek_back (_mut).
  • Get: get (_mut).
  • Views: as_slice (_mut),
  • Iteration: iter (_mut).
  • Visitation: visit_each (_mut), visit_slice (_mut).

• Shared slice (slice)

  • Constructors: try_from_slice, from_slice_with, from_slice_truncated.
  • Capacity: capacity (_prim), remaining_capacity (_prim), is_full.
  • Peek: peek_back.
  • Get: get.
  • Views: as_slice.
  • Iteration: iter.
  • Visitation: visit_each, visit_slice.

Implementations

impl<'a, T, S> BufferViewExample<'a, T, S>

Common methods.

pub const fn len(&self) -> NonValueU8<{ u8::MAX }>

Returns the number of elements currently stored in the buffer.

pub const fn len_prim(&self) -> u8

Returns the number of elements currently stored in the buffer.

pub const fn is_empty(&self) -> bool

Returns true if the buffer contains no elements.

impl<'a, T> BufferViewExample<'a, T, &'a mut [T]>

Buffer view over an exclusive slice.

Invariants

• Elements are stored in storage[0 .. len)
• len <= storage.len()

Notes

• This type does not own its elements
• Shrinking the buffer does not drop values, but mutating may overwrite.

pub const fn try_new(slice: &'a mut [T]) -> Option<Self>

Creates an empty buffer using the entire slice as backing storage.

Returns None if the slice length cannot be represented by the index type.

pub const fn new_truncated(slice: &'a mut [T]) -> Self

Creates an empty buffer, truncating the backing slice if it exceeds what the index type can represent.

pub const fn try_from_slice(slice: &'a mut [T]) -> Option<Self>

Creates a buffer over an exclusive slice.

Returns None if the slice length cannot be represented by the index type.

pub const fn from_slice_with( slice: &'a mut [T], len: NonValueU8<{ u8::MAX }>, ) -> Option<Self>

Creates a buffer over an exclusive slice with an explicit logical length.

Returns None if len > slice.len() or cannot be represented by the index type.

pub const fn from_slice_truncated(slice: &'a mut [T]) -> Self

Creates a buffer over an exclusive slice, truncating the visible active range if the slice length exceeds what the index type can represent.

pub const fn capacity(&self) -> NonValueU8<{ u8::MAX }>

Returns the capacity of the underlying slice storage.

pub const fn capacity_prim(&self) -> u8

Returns the capacity of the underlying slice storage.

pub const fn remaining_capacity(&self) -> NonValueU8<{ u8::MAX }>

Returns the number of additional elements that fit within the current capacity.

pub const fn remaining_capacity_prim(&self) -> u8

Returns the number of additional elements that fit within the current capacity.

pub const fn is_full(&self) -> bool

Returns true if the buffer has reached its capacity.

pub const fn clear(&mut self)

Sets the logical length to zero.

Does not drop elements.

pub const fn truncate(&mut self, new_len: NonValueU8<{ u8::MAX }>)

Sets the logical length to min(new_len, len).

If new_len >= len, this is a no-op.

pub const fn truncate_prim(&mut self, new_len: u8) -> Result<(), InvalidValue>

Primitive-index variant of truncate,

pub fn push_back(&mut self, value: T) -> Result<(), T>

Appends a value to the back of the buffer.

Returns Err(value) if the buffer is full.

pub const fn push_back_copy(&mut self, value: T) -> Result<(), T>

where T: Copy,

Appends a copy of value to the back of the buffer.

Returns Err(value) if the buffer is full.

pub fn push_slice(&mut self, src: &[T]) -> usize

where T: Clone,

Appends as many elements cloned from src as fit.

Returns the number of elements appended.

pub const fn push_slice_copy(&mut self, src: &[T]) -> usize

where T: Copy,

Appends as many copied elements from src as fit.

Returns the number of elements appended.

pub const fn push_slice_copy_exact(&mut self, src: &[T]) -> Result<(), usize>

where T: Copy,

Appends all copied elements from src, or none if insufficient capacity.

Returns Err(remaining_capacity) if not enough space is available.

pub fn pop_back_clone(&mut self) -> Option<T>

where T: Clone,

Removes and returns a cloned value from the back of the buffer.

pub const fn pop_back_copy(&mut self) -> Option<T>

where T: Copy,

Removes and returns a copied value from the back of the buffer.

pub const fn peek_back(&self) -> Option<&T>

Returns a shared reference to the last element without removing it.

pub const fn peek_mut_back(&mut self) -> Option<&mut T>

Returns an exclusive reference to the last element without removing it.

pub const fn get(&self, index: NonValueU8<{ u8::MAX }>) -> Option<&T>

Returns a shared reference to the element at index, or None if out of bounds.

pub const fn get_mut( &mut self, index: NonValueU8<{ u8::MAX }>, ) -> Option<&mut T>

Returns an exclusive reference to the element at index, or None if out of bounds.

pub const fn as_slice(&self) -> &[T]

Returns the active logical range as a slice.

pub const fn as_mut_slice(&mut self) -> &mut [T]

Returns the active logical range as a mutable slice.

pub fn iter(&self) -> impl Iterator<Item = &T>

Iterates over the initialized elements.

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut T>

Iterates mutably over the initialized elements.

pub fn visit_each<F>(&self, f: F)

where for<'v> F: Fn(&'v T),

Visits each initialized element without exposing borrow identity.

pub fn visit_each_mut<F>(&mut self, f: F)

where for<'v> F: Fn(&'v mut T),

Visits each initialized element mutably without exposing borrow identity.

pub fn visit_slice<F, R>(&self, f: F) -> R

where for<'v> F: FnOnce(&'v [T]) -> R,

Visits the active logical range as a shared slice of Some(T), without exposing borrow identity.

pub fn visit_mut_slice<F, R>(&mut self, f: F) -> R

where for<'v> F: FnOnce(&'v mut [T]) -> R,

Visits the active logical range as an exclusive slice of Some(T), without exposing borrow identity.

impl<'a, T> BufferViewExample<'a, T, &'a [T]>

Read-only buffer view over a shared slice.

Invariants

• Elements are read from storage[0 .. len)
• len <= storage.len()

Notes

• This type does not own its elements
• No mutation or removal operations are supported
• len limits the visible logical range

pub const fn try_from_slice(slice: &'a [T]) -> Option<Self>

Creates a buffer over a shared slice.

Returns None if the slice length cannot be represented by the index type.

pub const fn from_slice_with( slice: &'a [T], len: NonValueU8<{ u8::MAX }>, ) -> Option<Self>

Creates a buffer over an exclusive slice with an explicit logical length.

Returns None if len > slice.len() or cannot be represented by the index type.

pub const fn from_slice_truncated(slice: &'a [T]) -> Self

Creates a buffer over a shared slice, truncating the visible logical range if the slice length exceeds what the index type can represent.

pub const fn capacity(&self) -> NonValueU8<{ u8::MAX }>

Returns the capacity of the underlying slice storage.

pub const fn capacity_prim(&self) -> u8

Returns the capacity of the underlying slice storage.

pub const fn remaining_capacity(&self) -> NonValueU8<{ u8::MAX }>

Returns the number of additional elements that fit within the current capacity.

pub const fn remaining_capacity_prim(&self) -> u8

Returns the number of additional elements that fit within the current capacity.

pub const fn is_full(&self) -> bool

Returns true if the buffer has reached its capacity.

pub const fn peek_back(&self) -> Option<&T>

Returns a shared reference to the last element without removing it.

pub const fn get(&self, index: NonValueU8<{ u8::MAX }>) -> Option<&T>

Returns a shared reference to the element at index, or None if out of bounds.

pub const fn as_slice(&self) -> &[T]

Returns the active logical range as a slice.

pub fn iter(&self) -> impl Iterator<Item = &T>

Iterates over the initialized elements.

pub fn visit_each<F>(&self, f: F)

where for<'v> F: Fn(&'v T),

Visits each initialized element without exposing borrow identity.

pub fn visit_slice<F, R>(&self, f: F) -> R

where for<'v> F: FnOnce(&'v [T]) -> R,

Visits the active logical range as a shared slice without exposing borrow identity.

Trait Implementations

impl<'a, T: Clone, S: Clone> Clone for BufferViewExample<'a, T, S>

fn clone(&self) -> BufferViewExample<'a, T, S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, T: Copy, S: Copy> Copy for BufferViewExample<'a, T, S>

impl<'a, T: Debug, S: Debug> Debug for BufferViewExample<'a, T, S>

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

Formats the value using the given formatter.

impl<'a, T: Eq, S: Eq> Eq for BufferViewExample<'a, T, S>

impl<'a, T: Hash, S: Hash> Hash for BufferViewExample<'a, T, S>

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<'a, T: Ord, S: Ord> Ord for BufferViewExample<'a, T, S>

fn cmp(&self, other: &BufferViewExample<'a, T, S>) -> 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<'a, T: PartialEq, S: PartialEq> PartialEq for BufferViewExample<'a, T, S>

fn eq(&self, other: &BufferViewExample<'a, T, S>) -> 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<'a, T: PartialOrd, S: PartialOrd> PartialOrd for BufferViewExample<'a, T, S>

fn partial_cmp(&self, other: &BufferViewExample<'a, T, S>) -> 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<'a, T, S> StructuralPartialEq for BufferViewExample<'a, T, S>