cartel-core 0.24.0

Shared core for cartel database drivers
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

use dope::net::link::egress::data;
use o3::buffer::{Residency, pool};
use std::mem;
use zeroize::Zeroize as _;

pub enum Sensitivity {
    Plain,
    Secret,
}

impl Sensitivity {
    pub fn clear(&self, bytes: &mut [u8]) {
        if matches!(self, Self::Secret) {
            bytes.zeroize();
        }
    }
}

/// A completed request whose initialized bytes retain their clearing policy.
pub struct Buffer {
    data: pool::Cursor,
    kind: Sensitivity,
}

impl Buffer {
    pub const fn new(data: pool::Cursor, kind: Sensitivity) -> Self {
        Self { data, kind }
    }
}

impl AsRef<[u8]> for Buffer {
    fn as_ref(&self) -> &[u8] {
        self.data.as_ref()
    }
}

impl Drop for Buffer {
    fn drop(&mut self) {
        self.kind.clear(self.data.as_mut());
    }
}

impl Residency for Buffer {
    fn resident(&self) -> usize {
        self.data.resident()
    }
}

// SAFETY: shared borrows fix the entire pool slice and its capacity; secret
// clearing requires the final exclusive owner after all slice borrows end.
unsafe impl<'d> data::raw::Contiguous<'d> for Buffer {}

const _: () = {
    assert!(mem::size_of::<Buffer>() == mem::size_of::<pool::Cursor>() + mem::size_of::<usize>());
    assert!(mem::align_of::<Buffer>() == mem::align_of::<pool::Cursor>());
};