chaud-hot 0.1.0

Implementation detail of Chaud.
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

//! Various representations of a function (pointer).
//!
//! # Definitions
//!
//! * An **"erased"** function pointer is a function pointer that has been
//!   transmuted into a normal (non-function) pointer.
//! * The **"actual"** type refers to the non-erased type.
//!
//! # Summary
//!
//! The types in this module are somewhat layered:
//!
//! * [`ErasedFnPtrPointee`] specifies the pointee type used for erased function
//!   pointers. It is defined to be [`c_void`][core::ffi::c_void].
//! * [`RawErasedFnPtr`] is a raw pointer pointing to [`ErasedFnPtrPointee`]. It
//!   is only used when necessary for interacting with APIs exposed by other
//!   libraries.
//! * [`ErasedFnPtr`] conceptually wraps a [`RawErasedFnPtr`], but cannot be
//!   `null` (normal function pointers also cannot be `null`). It also
//!   implements [`Send`] and [`Sync`] (which aren't implemented for raw
//!   pointers).
//! * [`AtomicFnPtr`] conceptually wraps an [`ErasedFnPtr`], allowing it to be
//!   atomically updated.
//! * [`FuncStorage`] is parmeterized by [`Func`] and stores the corresponding
//!   [`AtomicFnPtr`]. It is the boundary between erased and non-erased (typed)
//!   layers.
//!
//! # Safety
//!
//! With the exception of [`ErasedFnPtrPointee`] and [`RawErasedFnPtr`] (which
//! are type aliases), all types defined in this module impose similar safety
//! requirements:
//!
//! 1) The **actual** type of the stored value must **never** change, and always
//!    be a function pointer implementing [`FnPtrLike`].
//!    * This implies that stored values are always non-null.
//!
//! 2) With the exception of [`AtomicFnPtr`], the stored **value** must never
//!    change.
//!    * This makes it easier to reason about (1).
//!
//! # Code Style
//!
//! * Every field should be considered an "unsafe" field and will be marked as
//!   such once
//!   [RFC 3458](https://github.com/rust-lang/rust/issues/132922) is
//!   stable.
//! * Methods should be `pub(super)` until they are needed outside this module.

pub use self::atomic::*;
pub use self::def::*;
pub use self::ptr::*;
pub use self::storage::*;

mod atomic;
mod def;
mod ptr;
mod storage;