frankencell 0.2.0

An alternative to `qcell` and `ghost-cell` that instead uses const generics
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

use std::marker::PhantomData;

use crate::cells::Cell;

/// A generic token that can store any data. See examples/arena.rs for an example of how this could
/// be used.
pub struct TokenWith<T, const ID: usize> (
    pub T,
    PhantomData<()>,
);

impl<T, const ID: usize> TokenWith<T, ID> {
    /// Creates a new token with this ID.
    ///
    /// # Safety:
    /// Because tokens represent access (mutable or immutable) to a memory location, creating >1
    /// tokens is equivalent to creating >1 mutable references to data.
    pub const unsafe fn new(t: T) -> Self {
        Self(t, PhantomData)
    }

    pub const fn cell(&self, t: T) -> Cell<T, ID> {
        Cell::new(t)
    }
}


/// A Token that represents access to one or more memory locations, each containing the same or
/// different data types.
///
/// Currently, this crate only provides [Cell](crate::cells::Cell), but you may create your own
/// ownership primitives. See examples/arena.rs for an example.
pub type Token<const ID: usize> = TokenWith<(), ID>;