Struct tokenlock::TokenLock

pub struct TokenLock<T: ?Sized, Keyhole> { /* fields omitted */ }

A mutual exclusive primitive that can be accessed using a Token<Keyhole> with a very low overhead.

See the module-level documentation for more details.

Implementations

impl<T, Keyhole> TokenLock<T, Keyhole>

pub const fn new(keyhole: Keyhole, data: T) -> Self

Construct a Self.

pub fn into_inner(self) -> T

Consume self, returning the contained data.

impl<T: ?Sized, Keyhole> TokenLock<T, Keyhole>

pub const fn keyhole(&self) -> &Keyhole

Get a reference to the contained Keyhole (keyhole).

pub fn get_mut(&mut self) -> &mut T

Get a mutable reference to the contained data.

pub const fn as_ptr(&self) -> *mut T

Get a raw pointer to the contained data.

pub fn read<'a, K: Token<Keyhole>>(&'a self, token: &'a K) -> &'a T

Get a reference to the contained data. Panic if token doesn't fit in the keyhole.

pub fn write<'a, K: Token<Keyhole>>(&'a self, token: &'a mut K) -> &'a mut T

Get a mutable reference to the contained data. Panic if token doesn't fit in the keyhole.

pub fn try_read<'a, K: Token<Keyhole>>(
    &'a self,
    token: &'a K
) -> Result<&'a T, BadTokenError>

Get a reference to the contained data. Return BadTokenError if token doesn't fit in the keyhole.

pub fn try_write<'a, K: Token<Keyhole>>(
    &'a self,
    token: &'a mut K
) -> Result<&'a mut T, BadTokenError>

Get a mutable reference to the contained data. Return BadTokenError if token doesn't fit in the keyhole.

impl<T, Keyhole> TokenLock<T, Keyhole>

pub fn get<K: Token<Keyhole>>(&self, token: &K) -> T where
    T: Clone, 

Get the contained data by cloning. Panic if token doesn't fit in the keyhole.

pub fn try_get<K: Token<Keyhole>>(&self, token: &K) -> Result<T, BadTokenError> where
    T: Clone, 

Get the contained data by cloning. Return BadTokenError if token doesn't fit in the keyhole.

pub fn take<K: Token<Keyhole>>(&self, token: &mut K) -> T where
    T: Default, 

Take the contained data, leaving Default::default() in its place. Panic if token doesn't fit in the keyhole.

pub fn try_take<K: Token<Keyhole>>(
    &self,
    token: &mut K
) -> Result<T, BadTokenError> where
    T: Default, 

Take the contained data, leaving Default::default() in its place. Return BadTokenError if token doesn't fit in the keyhole.

pub fn replace<K: Token<Keyhole>>(&self, token: &mut K, t: T) -> T

Replace the contained data with a new one. Panic if token doesn't fit in the keyhole.

This function corresponds to std::mem::replace.

pub fn replace_with<K: Token<Keyhole>>(
    &self,
    token: &mut K,
    f: impl FnOnce(&mut T) -> T
) -> T

Replace the contained data with a new one computed by the given closure. Panic if token doesn't fit in the keyhole.

This function corresponds to std::mem::replace.

pub fn try_replace_with<K: Token<Keyhole>>(
    &self,
    token: &mut K,
    f: impl FnOnce(&mut T) -> T
) -> Result<T, BadTokenError>

Replace the contained data with a new one computed by f. Panic if token doesn't fit in the keyhole.

This function corresponds to std::mem::replace.

pub fn swap<IOther, K: Token<Keyhole> + Token<IOther>>(
    &self,
    token: &mut K,
    other: &TokenLock<T, IOther>
)

Swap the contained data with the contained data of other. Panic if token doesn't fit in the keyhole of both TokenLocks.

This function corresponds to std::mem::swap.

pub fn try_swap<IOther, K: Token<Keyhole> + Token<IOther>>(
    &self,
    token: &mut K,
    other: &TokenLock<T, IOther>
) -> Result<(), BadTokenError>

Swap the contained data with the contained data of other. Return BadTokenError if token doesn't fit in the keyhole of both TokenLocks.

impl<T: Clone, Keyhole: Clone> TokenLock<T, Keyhole>

pub fn clone<K: Token<Keyhole>>(&self, token: &K) -> Self

Clone self. Panic if token doesn't fit in the keyhole.

pub fn try_clone<K: Token<Keyhole>>(
    &self,
    token: &K
) -> Result<Self, BadTokenError>

Clone self. Return BadTokenError if token doesn't fit in the keyhole.

Trait Implementations

impl<T: ?Sized, Keyhole: Debug> Debug for TokenLock<T, Keyhole>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Default + ?Sized, Keyhole: Default> Default for TokenLock<T, Keyhole>

fn default() -> TokenLock<T, Keyhole>

Returns the "default value" for a type.

impl<T: ?Sized + Send, Keyhole: Send> Send for TokenLock<T, Keyhole>

impl<T: ?Sized + Send + Sync, Keyhole: Sync> Sync for TokenLock<T, Keyhole>