ro_cell 0.1.0

A (mostly) readonly cell
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

//! Provide a cell that is (mostly) readonly.
//!
//! This crate should only be used for extremely performance critical scenarios; you
//! would normal want to use `once_cell` instead.

#![no_std]

use core::cell::UnsafeCell;
use core::fmt;
use core::mem::MaybeUninit;
use core::ops::Deref;

/// A cell that is (mostly) readonly.
///
/// It is expected to remain readonly for most time. Some use cases include set-once global
/// variables. Construction and mutation of `RoCell` are allowed in unsafe code, and the safety
/// must be ensured by the caller.
///
/// This type should only be used for extremely performance critical scenarios; you
/// would normal want to use `OnceCell` instead. Mutating `RoCell` in multi-threaded is
/// extremely dangerous, do not take it lightly.
pub struct RoCell<T>(UnsafeCell<MaybeUninit<T>>);

unsafe impl<T: Send> Send for RoCell<T> {}
unsafe impl<T: Sync> Sync for RoCell<T> {}

impl<T> Drop for RoCell<T> {
    #[inline]
    fn drop(&mut self) {
        unsafe { core::ptr::drop_in_place((*self.0.get()).as_mut_ptr()) };
    }
}

impl<T> RoCell<T> {
    /// Create a new `RoCell` that is initialized already.
    #[inline]
    pub const fn new(value: T) -> Self {
        RoCell(UnsafeCell::new(MaybeUninit::new(value)))
    }

    /// Create a new `RoCell` that is uninitialized.
    ///
    /// # Safety
    ///
    /// RoCell can be read in safe code. Therefore, we make its construction unsafe to
    /// permitting uninit value. If `T` needs drop, the caller must ensure that RoCell is
    /// initialised or forgotten before it is dropped.
    #[inline]
    pub const unsafe fn new_uninit() -> Self {
        RoCell(UnsafeCell::new(MaybeUninit::uninit()))
    }

    /// Initialize a `RoCell`.
    ///
    /// # Safety
    ///
    /// The caller must guarantee that there are no other reference to the
    /// content of this `RoCell` exists.
    ///
    /// No synchronisation is handled by RoCell.
    /// The caller must guarantee that no other threads are accessing this
    /// RoCell and other threads are properly synchronised after the call.
    #[inline]
    pub unsafe fn init(this: &Self, value: T) {
        core::ptr::write((*this.0.get()).as_mut_ptr(), value);
    }

    /// Replace a `RoCell` and return old content.
    ///
    /// # Safety
    ///
    /// The caller must guarantee that there are no other reference to the
    /// content of this `RoCell` exists.
    ///
    /// No synchronisation is handled by `RoCell`.
    /// The caller must guarantee that no other threads are accessing this
    /// RoCell and other threads are properly synchronised after the call.
    #[inline]
    pub unsafe fn replace(this: &Self, value: T) -> T {
        core::mem::replace(RoCell::as_mut(this), value)
    }

    /// Get a mutable reference to this `RoCell`.
    ///
    /// # Safety
    ///
    /// The caller must guarantee that there are no other reference to the
    /// content of this `RoCell` exists, until the returned mutable reference
    /// is dropped.
    ///
    /// No synchronisation is handled by `RoCell`.
    /// The caller must guarantee that no other threads are accessing this
    /// RoCell and other threads are properly synchronised after
    /// manipulating the mutable reference.
    #[inline]
    pub unsafe fn as_mut(this: &Self) -> &mut T {
        &mut *(*this.0.get()).as_mut_ptr()
    }
}

impl<T> Deref for RoCell<T> {
    type Target = T;

    #[inline]
    fn deref(&self) -> &T {
        unsafe { &*(*self.0.get()).as_ptr() }
    }
}

impl<T: fmt::Debug> fmt::Debug for RoCell<T> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        fmt::Debug::fmt(self.deref(), f)
    }
}