Struct PinCell

pub struct PinCell<T: ?Sized> { /* private fields */ }

A mutable memory location with dynamically checked borrow rules

Unlike RefCell, this type only allows pinned mutable access to the inner value, enabling a “pin-safe” version of interior mutability.

See the standard library documentation for more information.

Implementations

impl<T> PinCell<T>

pub const fn new(value: T) -> PinCell<T>

Creates a new PinCell containing value.

impl<T: ?Sized> PinCell<T>

pub fn borrow(&self) -> Ref<'_, T>

Immutably borrows the wrapped value.

The borrow lasts until the returned Ref exits scope. Multiple immutable borrows can be taken out at the same time (both pinned and unpinned).

pub fn try_borrow(&self) -> Result<Ref<'_, T>, BorrowError>

Immutably borrows the wrapped value, returning an error if the value is currently mutably borrowed.

The borrow lasts until the returned Ref exits scope. Multiple immutable borrows can be taken out at the same time (both pinned and unpinned).

This is the non-panicking variant of borrow.

pub fn borrow_mut<'a>(self: Pin<&'a Self>) -> PinMut<'a, T>

Mutably borrows the wrapped value, preserving its pinnedness.

The borrow lasts until the returned PinMut or all PinMuts derived from it exit scope. The value cannot be borrowed while this borrow is active.

pub fn try_borrow_mut<'a>( self: Pin<&'a Self>, ) -> Result<PinMut<'a, T>, BorrowMutError>

Mutably borrows the wrapped value, preserving its pinnedness, returning an error if the value is currently borrowed.

The borrow lasts until the returned PinMut or all PinMuts derived from it exit scope. The value cannot be borrowed while this borrow is active.

This is the non-panicking variant of borrow_mut.

pub fn borrow_pin<'a>(self: Pin<&'a Self>) -> PinRef<'a, T>

Immutably borrows the wrapped value, preserving its pinnedness.

The borrow lasts until the returned PinRef exits scope. Multiple immutable borrows can be taken out at the same time (both pinned and unpinned).

pub fn try_borrow_pin<'a>( self: Pin<&'a Self>, ) -> Result<PinRef<'a, T>, BorrowError>

Immutably borrows the wrapped value, preserving its pinnedness, returning an error if the value is currently mutably borrowed.

The borrow lasts until the returned PinRef exits scope. Multiple immutable borrows can be taken out at the same time (both pinned and unpinned).

This is the non-panicking variant of borrow_pin.

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

Returns a raw pointer to the underlying data in this cell.

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

Returns a mutable reference to the underlying data.

This call borrows PinCell mutably (at compile-time) so there is no need for dynamic checks.

However be cautious: this method expects self to be mutable, which is generally not the case when using a PinCell. Take a look at the borrow_mut method instead if self isn’t mutable.

Also, please be aware that this method is only for special circumstances and is usually not what you want. In case of doubt, use borrow_mut instead.

Trait Implementations

impl<T: Clone + ?Sized> Clone for PinCell<T>

fn clone(&self) -> PinCell<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug + ?Sized> Debug for PinCell<T>

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

Formats the value using the given formatter.

impl<T: Default + ?Sized> Default for PinCell<T>

fn default() -> PinCell<T>

Returns the “default value” for a type.

impl<T> From<RefCell<T>> for PinCell<T>

fn from(cell: RefCell<T>) -> PinCell<T>

Converts to this type from the input type.

impl<T> From<T> for PinCell<T>

fn from(value: T) -> PinCell<T>

Converts to this type from the input type.

impl<T> Into<RefCell<T>> for PinCell<T>

fn into(self) -> RefCell<T>

Converts this type into the (usually inferred) input type.

impl<T: Ord + ?Sized> Ord for PinCell<T>

fn cmp(&self, other: &PinCell<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq + ?Sized> PartialEq for PinCell<T>

fn eq(&self, other: &PinCell<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd + ?Sized> PartialOrd for PinCell<T>

fn partial_cmp(&self, other: &PinCell<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Eq + ?Sized> Eq for PinCell<T>

impl<T: ?Sized> StructuralPartialEq for PinCell<T>