o3 0.34.1

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

use crate::{
    buffer,
    buffer::{resident, storage, storage::regions},
    mem::rc,
};

/// One-word exact allocation owner bounded by a resident domain lifetime.
#[derive(Debug, Default)]
#[repr(transparent)]
pub struct Exact<'d> {
    owner: Option<regions::Complete<'d>>,
}

impl<'d> Exact<'d> {
    #[must_use]
    pub fn from_plain(plain: storage::Exact) -> Self {
        Self {
            owner: plain.inner.map(regions::Init::<()>::bind),
        }
    }

    pub(in crate::buffer) fn from_init(inner: regions::Init<resident::Budget<'d>>) -> Self {
        Self {
            owner: Some(inner.bind()),
        }
    }

    #[must_use]
    pub const fn new() -> Self {
        Self { owner: None }
    }

    pub fn try_copy(
        budget: &resident::Budget<'d>,
        bytes: &[u8],
    ) -> Result<Self, resident::AllocError> {
        Self::try_slices(budget, [bytes])
    }

    pub fn try_slices<const N: usize>(
        budget: &resident::Budget<'d>,
        slices: [&[u8]; N],
    ) -> Result<Self, resident::AllocError> {
        let Some(slices) =
            buffer::raw::Slices::try_new(slices).map_err(resident::AllocError::Capacity)?
        else {
            return Ok(Self::new());
        };
        Ok(slices.try_copy(budget)?)
    }

    #[must_use]
    pub fn into_shared(self) -> resident::Shared<'d> {
        self.owner
            .map_or_else(resident::Shared::new, regions::Complete::into_buf)
    }

    pub fn bytes(&self) -> usize {
        self.owner.as_ref().map_or(0, regions::Complete::bytes)
    }

    pub fn as_slice(&self) -> &[u8] {
        self.owner.as_ref().map_or(&[], regions::Complete::as_slice)
    }
}

impl Exact<'_> {
    pub fn try_clone(&self) -> Result<Self, rc::Error> {
        Ok(Self {
            owner: self
                .owner
                .as_ref()
                .map(regions::Complete::try_clone)
                .transpose()?,
        })
    }
}

const _: () = assert!(size_of::<Exact<'static>>() == size_of::<usize>());

impl AsRef<[u8]> for Exact<'_> {
    fn as_ref(&self) -> &[u8] {
        self.as_slice()
    }
}

// SAFETY: exact owners expose one immutable initialized allocation until dropped.
unsafe impl buffer::raw::Source for Exact<'_> {}