dope-runtime 0.15.1

The manifold runtime
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

//! Runtime-owned randomness bound to one exact generative driver domain.

use std::{hash, marker, mem};

use siphasher::sip;

mod seed;

pub(crate) use seed::Seed;

/// Keyed hash builder issued for one exact generative driver domain.
///
/// The driver lifetime is invariant and cannot be widened:
///
/// ```compile_fail
/// use dope_runtime::random::HashState;
///
/// fn escape<'d>(state: HashState<'d>) -> HashState<'static> {
///     state
/// }
/// ```
///
/// Construction is reserved for a runtime session holding the matching brand:
///
/// ```compile_fail,E0624
/// use dope_runtime::random::HashState;
///
/// let _ = HashState::new([1, 2]);
/// ```
///
/// Building a hasher preserves the same invariant driver lifetime:
///
/// ```compile_fail
/// use std::hash::BuildHasher;
/// use dope_runtime::random::{HashState, Hasher};
///
/// fn erase<'d>(state: HashState<'d>) -> Hasher<'static> {
///     state.build_hasher()
/// }
/// ```
#[derive(Clone, Copy)]
pub struct HashState<'d> {
    words: [u64; 2],
    _driver: marker::PhantomData<fn(&'d ()) -> &'d ()>,
    _thread: o3::ThreadBound,
}

impl<'d> HashState<'d> {
    const fn new(words: [u64; 2]) -> Self {
        Self {
            words,
            _driver: marker::PhantomData,
            _thread: o3::ThreadBound::NEW,
        }
    }
}

impl<'d> hash::BuildHasher for HashState<'d> {
    type Hasher = Hasher<'d>;

    fn build_hasher(&self) -> Self::Hasher {
        Hasher::new(sip::SipHasher13::new_with_keys(
            self.words[0],
            self.words[1],
        ))
    }
}

const _: () = assert!(mem::size_of::<HashState<'static>>() == 2 * mem::size_of::<u64>());

/// Hashing state retaining the exact driver brand of its key source.
#[doc(hidden)]
pub struct Hasher<'d> {
    inner: sip::SipHasher13,
    _driver: marker::PhantomData<fn(&'d ()) -> &'d ()>,
    _thread: o3::ThreadBound,
}

impl<'d> Hasher<'d> {
    const fn new(inner: sip::SipHasher13) -> Self {
        Self {
            inner,
            _driver: marker::PhantomData,
            _thread: o3::ThreadBound::NEW,
        }
    }
}

impl hash::Hasher for Hasher<'_> {
    fn finish(&self) -> u64 {
        self.inner.finish()
    }

    fn write(&mut self, bytes: &[u8]) {
        self.inner.write(bytes);
    }

    fn write_u8(&mut self, value: u8) {
        self.inner.write_u8(value);
    }

    fn write_u16(&mut self, value: u16) {
        self.inner.write_u16(value);
    }

    fn write_u32(&mut self, value: u32) {
        self.inner.write_u32(value);
    }

    fn write_u64(&mut self, value: u64) {
        self.inner.write_u64(value);
    }

    fn write_usize(&mut self, value: usize) {
        self.inner.write_usize(value);
    }
}

const _: () = assert!(mem::size_of::<Hasher<'static>>() == mem::size_of::<sip::SipHasher13>());

/// Stable separation between independent uses of one worker seed.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
#[repr(transparent)]
pub struct Domain(u64);

impl Domain {
    pub const fn new(value: u64) -> Self {
        Self(value)
    }

    pub const fn from_bytes(value: [u8; 8]) -> Self {
        Self(u64::from_be_bytes(value))
    }

    pub(super) const fn get(self) -> u64 {
        self.0
    }
}

const _: () = assert!(mem::size_of::<Domain>() == mem::size_of::<u64>());