Struct PinTokenLock 

pub struct PinTokenLock<T: ?Sized, Keyhole> { /* private fields */ }

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

Unlike the unpinned variant TokenLock, PinTokenLock does not expose &mut T unless the receiver type is &mut Self. This way, the pinning invariants are maintained.

See the module-level documentation for more details.

Examples

use std::{pin::Pin, sync::Arc};
use tokenlock::{ArcToken, PinTokenLock};
let mut token = ArcToken::new();
let mut value = 0;
let future = Arc::pin(PinTokenLock::new(token.id(), async { value = 42; }));

// Use `token` to get `Pin<&mut impl Future>`
futures::executor::block_on(Pin::as_ref(&future).write_pin(&mut token));
drop(future);

assert_eq!(value, 42);

Implementations

impl<T, Keyhole> PinTokenLock<T, Keyhole>

Construction and Destruction

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

Construct a Self.

pub fn wrap(data: T) -> Self

where Keyhole: Default,

Construct a Self with a default-constructed Keyhole.

pub fn into_inner(self) -> T

Consume self, returning the contained data.

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

Miscellaneous

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

Get a reference to the contained Keyhole (keyhole).

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

Get a raw pointer to the contained data.

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

Borrowing

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 read_pin<'a, K: Token<Keyhole>>( self: Pin<&'a Self>, token: &'a K, ) -> Pin<&'a T>

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

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

Get a mutable pinned 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_read_pin<'a, K: Token<Keyhole>>( self: Pin<&'a Self>, token: &'a K, ) -> Result<Pin<&'a T>, BadTokenError>

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

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

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

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

Get a mutable reference to the contained data.

pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut T>

Get a mutable pinned reference to the contained data.

impl<T, Keyhole> PinTokenLock<T, Keyhole>

Utilities

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 set<K: Token<Keyhole>>(&self, token: &mut K, value: T)

Assign a new value. Panic if token doesn’t fit in thekeyhole.

pub fn try_set<K: Token<Keyhole>>( &self, token: &mut K, value: T, ) -> Result<(), BadTokenError>

Assign a new value. Return BadTokenError if token doesn’t fit in the keyhole.

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

Cloning

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: ConstDefault, Keyhole: ConstDefault> ConstDefault for PinTokenLock<T, Keyhole>

const DEFAULT: Self

The constant default value.

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

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

Formats the value using the given formatter.

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

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

Returns the “default value” for a type.

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

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