buffex 0.0.1

BUFFer EXtensions: ring buffer and buffer chaining.
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

use abs_buff::{TrBuffPeeker, TrBuffReader, TrBuffWriter};

pub trait TrAsyncRingBuffer<T: Clone = u8> {
    type Writer<'a>: 'a + TrAsyncRingBuffWriter<T, RingBuffer = Self>
    where
        Self: 'a;

    type Reader<'a>: 'a + TrAsyncRingBuffReader<T, RingBuffer = Self>
    where
        Self: 'a;

    fn capacity(&self) -> usize;

    fn data_size(&self) -> usize;

    fn writer(&mut self) -> Self::Writer<'_>;

    fn reader(&mut self) -> Self::Reader<'_>;
}

pub trait TrAsyncRingBuffPeeker<T: Clone = u8>
where
    Self: TrBuffPeeker<T>
        + core::borrow::Borrow<Self::RingBuffer>
        + core::convert::AsMut<Self::Reader>,
{
    type RingBuffer: TrAsyncRingBuffer<T>;
    type Reader: TrAsyncRingBuffReader<T>;

    fn try_peek(&mut self, skip: usize) -> Result<
        <Self as TrBuffPeeker<T>>::BuffRef<'_>,
        <Self as TrBuffPeeker<T>>::Error,
    >;
}

pub trait TrAsyncRingBuffReader<T: Clone = u8>
where
    Self: TrBuffReader<T>
        + core::borrow::Borrow<Self::RingBuffer>
        + core::convert::AsMut<Self::Peeker>,
{
    type RingBuffer: TrAsyncRingBuffer<T>;
    type Peeker: TrAsyncRingBuffPeeker<T>;

    fn try_read(&mut self, length: usize) -> Result<
        <Self as TrBuffReader<T>>::BuffRef<'_>,
        <Self as TrBuffReader<T>>::Error,
    >;
}

pub trait TrAsyncRingBuffWriter<T: Clone = u8>
where
    Self: TrBuffWriter<T>
        + core::borrow::Borrow<Self::RingBuffer>,
{
    type RingBuffer: TrAsyncRingBuffer<T>;

    fn try_write(&mut self, length: usize) -> Result<
        <Self as TrBuffWriter<T>>::BuffMut<'_>,
        <Self as TrBuffWriter<T>>::Error,
    >;
}