phoros 0.1.0

Zero-allocation ring buffer with XOR delta encoding and state rollback
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

/// Trait for arena backing storage.
///
/// Implementations decide where the byte arena lives — stack, heap, or borrowed
/// memory — while the ring buffer logic stays generic over this trait.
///
/// # Examples
///
/// ```
/// use phoros::ArenaStorage;
///
/// let mut buf = [0u8; 1024];
/// assert_eq!(buf.len(), 1024);
/// assert_eq!(buf.as_slice().len(), 1024);
/// buf.as_mut_slice()[0] = 42;
/// ```
pub trait ArenaStorage {
    /// Returns the number of bytes in the storage.
    fn len(&self) -> usize;

	// Returns true if empty.
	fn is_empty(&self) -> bool;

    /// Borrow the storage as an immutable byte slice.
    fn as_slice(&self) -> &[u8];

    /// Borrow the storage as a mutable byte slice.
    fn as_mut_slice(&mut self) -> &mut [u8];
}

impl<const N: usize> ArenaStorage for [u8; N] {
    #[inline]
    fn len(&self) -> usize {
        N
    }
	#[inline]
	fn is_empty(&self) -> bool {
		self.len() == 0
	}
    #[inline]
    fn as_slice(&self) -> &[u8] {
        self
    }
    #[inline]
    fn as_mut_slice(&mut self) -> &mut [u8] {
        self
    }
}

impl ArenaStorage for [u8] {
    #[inline]
    fn len(&self) -> usize {
        (*self).len()
    }
	#[inline]
	fn is_empty(&self) -> bool {
		self.len() == 0
	}
    #[inline]
    fn as_slice(&self) -> &[u8] {
        self
    }
    #[inline]
    fn as_mut_slice(&mut self) -> &mut [u8] {
        self
    }
}

#[cfg(feature = "alloc")]
impl ArenaStorage for alloc::boxed::Box<[u8]> {
    #[inline]
    fn len(&self) -> usize {
        (**self).len()
    }
	#[inline]
	fn is_empty(&self) -> bool {
		self.len() == 0
	}
    #[inline]
    fn as_slice(&self) -> &[u8] {
        self
    }
    #[inline]
    fn as_mut_slice(&mut self) -> &mut [u8] {
        self
    }
}