o3 0.26.3

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

use std::{marker, num::NonZero, ptr};

use crate::buffer::{self, write, write::consume};

/// A checked cursor retaining its complete initialized output slice.
pub struct Slice<'a> {
    base: ptr::NonNull<u8>,
    pub(super) current: *mut u8,
    pub(super) remaining: usize,
    borrow: marker::PhantomData<&'a mut [u8]>,
}

impl<'a> Slice<'a> {
    pub fn new(out: &'a mut [u8]) -> Self {
        let len = out.len();
        let base = ptr::NonNull::from(out).cast();
        Self {
            base,
            current: base.as_ptr(),
            remaining: len,
            borrow: marker::PhantomData,
        }
    }

    pub fn finish(self) -> usize {
        self.current.addr() - self.base.addr().get()
    }

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

    /// Returns exactly the written prefix under the original exclusive borrow.
    pub fn into_mut(self) -> &'a mut [u8] {
        // SAFETY: admission keeps current at or before the original output's end;
        // consuming this cursor transfers exactly its exclusive initialized prefix.
        unsafe { buffer::raw::range_mut(self.base.as_ptr(), 0, self.finish()) }
    }

    /// Succeeds only after the complete original output slice was written.
    pub fn try_complete(self) -> Result<(), consume::Error> {
        let Some(left) = NonZero::new(self.remaining) else {
            return Ok(());
        };
        let written = self.finish();
        Err(consume::Error::new(left.saturating_add(written), written))
    }
}

impl write::Sink for Slice<'_> {
    type Error = consume::Error;

    fn write_slices<const N: usize>(&mut self, slices: [&[u8]; N]) -> Result<(), Self::Error> {
        write::Staging::try_new(self, slices).map(buffer::raw::Copy::copy)
    }
}

impl buffer::raw::Space for Slice<'_> {
    fn remaining(&self) -> usize {
        self.remaining()
    }
}

const _: () = {
    assert!(size_of::<Slice<'static>>() == 3 * size_of::<usize>());
    assert!(size_of::<Option<Slice<'static>>>() == size_of::<Slice<'static>>());
};