o3 0.13.0

shared-nothing primitives
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147

use crate::buffer::{
    self, bytes,
    pool::{self, state},
    write,
};

/// A pooled byte cursor over one logical readable range.
pub struct Cursor<C: pool::Capacity = pool::RuntimeCapacity> {
    pub(super) lease: pool::Lease<state::Uninitialized, C>,
    pub(super) head: u32,
}

impl<C: pool::Capacity> Cursor<C> {
    pub(super) const fn new(lease: pool::Lease<state::Uninitialized, C>) -> Self {
        Self { lease, head: 0 }
    }
    #[must_use]
    pub fn len(&self) -> usize {
        self.lease.len() - self.head as usize
    }

    #[must_use]
    pub fn is_empty(&self) -> bool {
        if self.head == 0 {
            self.lease.is_empty()
        } else {
            self.head as usize == self.lease.len()
        }
    }

    #[must_use]
    pub fn spare_capacity(&self) -> usize {
        self.lease.capacity() - self.len()
    }

    #[must_use]
    pub fn as_slice(&self) -> &[u8] {
        &self.lease.as_slice()[self.head as usize..]
    }

    pub fn as_mut_slice(&mut self) -> &mut [u8] {
        let head = self.head as usize;
        &mut self.lease.as_mut_slice()[head..]
    }

    pub fn try_extend(&mut self, src: &[u8]) -> Result<(), buffer::CapacityError> {
        let capacity = self.lease.capacity();
        let lease_len = self.lease.len();
        if src.len() > capacity - lease_len
            && src.len() <= capacity - (lease_len - self.head as usize)
        {
            self.compact();
        }
        self.lease.try_extend(src)
    }

    pub fn try_push(&mut self, byte: u8) -> Result<(), buffer::CapacityError> {
        if self.lease.len() == self.lease.capacity() && self.head != 0 {
            self.compact();
        }
        self.lease.try_push(byte)
    }

    pub fn try_extend_from_slices<const N: usize>(
        &mut self,
        slices: [&[u8]; N],
    ) -> Result<(), buffer::CapacityError> {
        let additional = slices.iter().try_fold(0usize, |len, slice| {
            use crate::buffer::CapacityError;
            len.checked_add(slice.len())
                .ok_or_else(|| CapacityError::new(usize::MAX, self.lease.capacity()))
        })?;
        if additional > self.lease.capacity() - self.lease.len()
            && additional <= self.spare_capacity()
        {
            self.compact();
        }
        self.lease.try_extend_from_slices(slices)
    }

    pub fn truncate(&mut self, len: usize) {
        let len = len.min(self.len());
        self.lease.truncate(self.head as usize + len);
        if len == 0 {
            self.head = 0;
            self.lease.truncate(0);
        }
    }

    pub fn as_ptr(&self) -> *const u8 {
        self.as_slice().as_ptr()
    }

    /// Returns a contiguous writer after compacting the readable range.
    pub fn spare_writer(&mut self) -> write::SpareWriter<'_> {
        self.compact();
        self.lease.spare_writer()
    }

    #[must_use]
    pub fn freeze(self) -> bytes::Bytes<bytes::Retained> {
        use crate::buffer::PrefixConsumer;
        let head = self.head as usize;
        let mut bytes = bytes::Bytes::<bytes::Retained>::from(self.lease.freeze());
        let _ = PrefixConsumer::consume_prefix_up_to(&mut bytes, head);
        bytes
    }

    fn compact(&mut self) {
        if self.head == 0 {
            return;
        }
        let len = self.len();
        self.lease
            .as_mut_slice()
            .copy_within(self.head as usize.., 0);
        self.head = 0;
        self.lease.truncate(len);
    }

    fn consume_valid(&mut self, amount: usize) {
        debug_assert!(amount <= self.len());
        self.head += amount as u32;
        if self.head as usize == self.lease.len() {
            self.head = 0;
            self.lease.truncate(0);
        }
    }
}

impl<C: pool::Capacity> AsRef<[u8]> for Cursor<C> {
    fn as_ref(&self) -> &[u8] {
        self.as_slice()
    }
}

impl<C: pool::Capacity> buffer::PrefixLength for Cursor<C> {
    fn prefix_len(&self) -> usize {
        self.len()
    }
}

impl<C: pool::Capacity> buffer::PrefixConsumer for Cursor<C> {
    fn consume_validated_prefix(&mut self, proof: buffer::PrefixProof) {
        self.consume_valid(proof.amount());
    }
}