ringo-buff 0.1.0

Ring buffers for bytes, with heap and stack storage.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

use crate::{CircularBuffer, Storage};
use ::hybrid_array::Array;

pub use ::hybrid_array::ArraySize;

impl<N: ArraySize> crate::sealed::StorageBase for Array<u8, N> {}

impl<N: ArraySize> Storage for Array<u8, N> {
    fn len(&self) -> usize {
        self.as_slice().len()
    }

    fn as_slice(&self) -> &[u8] {
        self.as_slice()
    }

    fn as_mut_slice(&mut self) -> &mut [u8] {
        self.as_mut_slice()
    }

    fn split_at(&self, offset: usize) -> (&[u8], &[u8]) {
        self.as_slice().split_at(offset)
    }

    fn split_at_mut(&mut self, offset: usize) -> (&mut [u8], &mut [u8]) {
        self.as_mut_slice().split_at_mut(offset)
    }
}

/// A circular buffer backed by `hybrid_array::Array`.
///
/// This implementation is used when the `hybrid-array` feature is **enabled**.
/// It allows for type-level sizes (e.g., `U10`) compatible with `hybrid-array` & `typenum`.
pub type StackBuffer<N> = CircularBuffer<Array<u8, N>>;

impl<N: ArraySize> StackBuffer<N> {
    /// Creates a new buffer.
    ///
    /// # Panics
    ///
    /// Panics if array size is 0.
    ///
    /// # Examples
    ///
    /// ```
    /// use ringo_buff::{StackBuffer, ArraySize};
    /// use hybrid_array::sizes::U128;
    ///
    /// let buf: StackBuffer<U128> = StackBuffer::new();
    /// assert_eq!(buf.capacity(), 128);
    /// ```
    pub fn new() -> Self {
        assert!(N::to_usize() > 0);
        Self::_new_with_storage(Array::default())
    }
}