o3 0.9.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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
use std::collections::VecDeque;
use std::ops::Range;
use std::process::abort;

use super::PrefixLength;
use super::bytes::{Bytes, Retained};

pub(super) mod ring;
pub(super) mod rolling;

mod private {
    pub trait Sealed {}
}

/// A segment that can reject invalid prefix consumption before mutating itself.
pub trait AdvanceSegment: AsRef<[u8]> + private::Sealed {
    fn try_advance(&mut self, amount: usize) -> bool;
}

/// A byte-length-aware queue of independently owned segments.
/// It tracks ordering and aggregate length while callers retain
/// protocol-specific byte and segment limits.
#[derive(Debug)]
pub struct SegmentQueue<T> {
    segments: VecDeque<T>,
    len: usize,
}

#[derive(Debug)]
pub struct RetainedSegmentQueue<T> {
    queue: SegmentQueue<T>,
    front_offset: usize,
}

impl<T> SegmentQueue<T> {
    #[must_use]
    pub const fn new() -> Self {
        Self {
            segments: VecDeque::new(),
            len: 0,
        }
    }

    pub const fn len(&self) -> usize {
        self.len
    }

    pub fn is_empty(&self) -> bool {
        self.len == 0
    }

    pub fn segment_count(&self) -> usize {
        self.segments.len()
    }

    pub fn front(&self) -> Option<&T> {
        self.segments.front()
    }

    pub fn back(&self) -> Option<&T> {
        self.segments.back()
    }

    pub fn clear(&mut self) {
        self.segments.clear();
        self.len = 0;
    }

    pub fn clear_from(&mut self, front_offset: &mut usize) {
        self.clear();
        *front_offset = 0;
    }
}

impl<T: AsRef<[u8]>> SegmentQueue<T> {
    /// Appends without copying. Empty segments are discarded.
    /// On length overflow, the segment is returned and the queue is unchanged.
    pub fn try_push_back(&mut self, segment: T) -> Result<(), T> {
        let segment_len = segment.as_ref().len();
        if segment_len == 0 {
            return Ok(());
        }
        let Some(len) = self.len.checked_add(segment_len) else {
            return Err(segment);
        };
        self.segments.push_back(segment);
        self.len = len;
        Ok(())
    }

    /// Mutates the last segment after reserving its maximum permitted growth.
    ///
    /// Length tracking is restored from the actual delta during unwinding.
    pub fn try_mutate_back<R>(
        &mut self,
        additional: usize,
        mutate: impl FnOnce(&mut T) -> R,
    ) -> Option<R> {
        let total_ceiling = self.len.checked_add(additional)?;
        let segment = self.segments.back_mut()?;
        let before = segment.as_ref().len();
        let segment_ceiling = before.checked_add(additional)?;
        let mutation = SegmentMutation {
            segment,
            total: &mut self.len,
            total_ceiling,
            segment_ceiling,
            before,
        };
        Some(mutate(mutation.segment))
    }

    pub fn range_available(&self, front_offset: usize, offset: usize, len: usize) -> bool {
        if !self.front_offset_valid(front_offset) {
            return false;
        }
        offset.checked_add(len).is_some_and(|end| end <= self.len)
    }

    /// Visits a logical range without materializing it.
    /// `front_offset` is consumed physical prefix; `offset` starts from the
    /// remaining logical bytes.
    pub fn for_each_range(
        &self,
        front_offset: usize,
        offset: usize,
        len: usize,
        mut visit: impl FnMut(&[u8]),
    ) -> bool {
        if !self.range_available(front_offset, offset, len) {
            return false;
        }
        if len == 0 {
            return true;
        }
        let Some(mut skip) = front_offset.checked_add(offset) else {
            return false;
        };
        let mut remaining = len;
        for segment in &self.segments {
            let bytes = segment.as_ref();
            if skip >= bytes.len() {
                skip -= bytes.len();
                continue;
            }
            let bytes = &bytes[skip..];
            let take = remaining.min(bytes.len());
            visit(&bytes[..take]);
            remaining -= take;
            skip = 0;
            if remaining == 0 {
                return true;
            }
        }
        false
    }

    pub fn copy_range_into(&self, front_offset: usize, offset: usize, output: &mut [u8]) -> bool {
        let mut written = 0;
        let copied = self.for_each_range(front_offset, offset, output.len(), |bytes| {
            let end = written + bytes.len();
            output[written..end].copy_from_slice(bytes);
            written = end;
        });
        debug_assert!(!copied || written == output.len());
        copied
    }

    pub fn extend_range(
        &self,
        front_offset: usize,
        offset: usize,
        len: usize,
        output: &mut Vec<u8>,
    ) -> bool {
        self.for_each_range(front_offset, offset, len, |bytes| {
            output.extend_from_slice(bytes);
        })
    }

    /// Returns the owner and physical range when a logical range is contiguous.
    pub fn contiguous_segment(
        &self,
        front_offset: usize,
        offset: usize,
        len: usize,
    ) -> Option<(&T, Range<usize>)> {
        if len == 0 || !self.range_available(front_offset, offset, len) {
            return None;
        }
        let mut skip = front_offset.checked_add(offset)?;
        for segment in &self.segments {
            let segment_len = segment.as_ref().len();
            if skip >= segment_len {
                skip -= segment_len;
                continue;
            }
            return (len <= segment_len - skip).then_some((segment, skip..skip + len));
        }
        None
    }

    /// Consumes a prefix while retaining a cursor into the physical first
    /// segment. Fully consumed segments are passed to `removed`.
    pub fn try_consume_front_from(
        &mut self,
        front_offset: &mut usize,
        amount: usize,
        removed: impl FnMut(T),
    ) -> bool {
        if !self.range_available(*front_offset, 0, amount) {
            return false;
        }
        unsafe { self.consume_front_valid_from(front_offset, amount, removed) };
        true
    }

    unsafe fn consume_front_valid_from(
        &mut self,
        front_offset: &mut usize,
        mut amount: usize,
        mut removed: impl FnMut(T),
    ) {
        debug_assert!(self.range_available(*front_offset, 0, amount));
        while amount != 0 {
            let segment = unsafe { self.segments.front().unwrap_unchecked() };
            let available = segment.as_ref().len() - *front_offset;
            if amount < available {
                *front_offset += amount;
                self.len -= amount;
                return;
            }
            amount -= available;
            self.len -= available;
            let segment = unsafe { self.segments.pop_front().unwrap_unchecked() };
            *front_offset = 0;
            removed(segment);
        }
    }

    fn front_offset_valid(&self, front_offset: usize) -> bool {
        match self.segments.front() {
            Some(segment) => front_offset < segment.as_ref().len(),
            None => front_offset == 0 && self.len == 0,
        }
    }
}

impl<T: AdvanceSegment> SegmentQueue<T> {
    /// Consumes a prefix by advancing a partial front segment in place.
    pub fn try_consume_front(&mut self, mut amount: usize) -> bool {
        if amount > self.len {
            return false;
        }
        while amount != 0 {
            let Some(segment) = self.segments.front() else {
                return false;
            };
            let available = segment.as_ref().len();
            if amount < available {
                let Some(segment) = self.segments.front_mut() else {
                    return false;
                };
                if !segment.try_advance(amount) {
                    return false;
                }
                self.len -= amount;
                return true;
            }
            amount -= available;
            self.len -= available;
            self.segments.pop_front();
        }
        true
    }
}

impl<T> Default for SegmentQueue<T> {
    fn default() -> Self {
        Self::new()
    }
}

impl<T> PrefixLength for SegmentQueue<T> {
    fn prefix_len(&self) -> usize {
        self.len()
    }
}

impl<T> RetainedSegmentQueue<T> {
    #[must_use]
    pub const fn new() -> Self {
        Self {
            queue: SegmentQueue::new(),
            front_offset: 0,
        }
    }

    pub const fn len(&self) -> usize {
        self.queue.len()
    }

    pub fn is_empty(&self) -> bool {
        self.queue.is_empty()
    }

    pub fn segment_count(&self) -> usize {
        self.queue.segment_count()
    }

    pub fn front(&self) -> Option<&T> {
        self.queue.front()
    }

    pub fn back(&self) -> Option<&T> {
        self.queue.back()
    }

    pub fn clear(&mut self) {
        self.queue.clear_from(&mut self.front_offset);
    }
}

impl<T: AsRef<[u8]>> RetainedSegmentQueue<T> {
    pub fn try_push_back(&mut self, segment: T) -> Result<(), T> {
        self.queue.try_push_back(segment)
    }

    pub fn try_mutate_back<R>(
        &mut self,
        additional: usize,
        mutate: impl FnOnce(&mut T) -> R,
    ) -> Option<R> {
        self.queue.try_mutate_back(additional, mutate)
    }

    pub fn range_available(&self, offset: usize, len: usize) -> bool {
        self.queue.range_available(self.front_offset, offset, len)
    }

    pub fn extend_range(&self, offset: usize, len: usize, output: &mut Vec<u8>) -> bool {
        self.queue
            .extend_range(self.front_offset, offset, len, output)
    }

    pub fn consume_prefix_up_to(&mut self, requested: usize, removed: impl FnMut(T)) -> usize {
        let amount = requested.min(self.queue.len());
        unsafe {
            self.queue
                .consume_front_valid_from(&mut self.front_offset, amount, removed)
        };
        amount
    }
}

impl<T> Default for RetainedSegmentQueue<T> {
    fn default() -> Self {
        Self::new()
    }
}

impl<T> PrefixLength for RetainedSegmentQueue<T> {
    fn prefix_len(&self) -> usize {
        self.len()
    }
}

impl private::Sealed for Bytes<Retained> {}

impl AdvanceSegment for Bytes<Retained> {
    fn try_advance(&mut self, amount: usize) -> bool {
        self.try_advance(amount)
    }
}

struct SegmentMutation<'a, T: AsRef<[u8]>> {
    segment: &'a mut T,
    total: &'a mut usize,
    total_ceiling: usize,
    segment_ceiling: usize,
    before: usize,
}

impl<T: AsRef<[u8]>> Drop for SegmentMutation<'_, T> {
    fn drop(&mut self) {
        let after = self.segment.as_ref().len();
        if after > self.segment_ceiling {
            abort();
        }
        let next = if after >= self.before {
            self.total.checked_add(after - self.before)
        } else {
            self.total.checked_sub(self.before - after)
        };
        let Some(next) = next else {
            abort();
        };
        if next > self.total_ceiling {
            abort();
        }
        *self.total = next;
    }
}