Struct TempInstPin

pub struct TempInstPin<'a, T: TempReprMut + 'a>(/* private fields */);

A wrapper around an instance of T which implements TempReprMut, i.e. is a temporary representation of a type T::Mutable<'a>.

TempInstPin itself has a lifetime parameter 'a and borrows the object passed to TempInstPin::new for that lifetime; therefore it is logically equivalent to T::Mutable<'a>. However, it can hand out references to the lifetime-less type T via TempInstPin::deref_pin. The references have type Pin<&mut T>; use the slightly less efficient TempInstMut wrapper if &mut T is required instead.

Implementations

impl<'a, T: TempReprMut> TempInstPin<'a, T>

pub fn new(obj: T::Mutable<'a>) -> Self

Creates a TempInstPin from an instance of T::Mutable.

A pinned mutable reference to T can be obtained from the result via Self::deref_pin. As deref_pin expects self to be pinned, use the core::pin::pin! macro to pin the result of Self::new on the stack.

Note that only the TempInstPin reference will be pinned; this is completely independent of whether T::Mutable is a pinned reference. E.g. T can be TempRefMut or TempRefPin, and then T::get_mut_pinned will return a mutable or pinned mutable reference accordingly.

Remarks

For many types, including TempRef, T::Mutable is actually the same as T::Shared. This can be useful when combining mutable and shared references in a tuple. E.g. T = (TempRefMut<U>, TempRef<V>) represents (&mut U, &V), and this is preserved by TempInstPin::new, whereas TempInst::new treats it as (&U, &V).

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

Dereferences a pinned mutable TempInstMut reference to obtain a pinned mutable reference to T. From that reference, the original object can be obtained via TempReprMut::get_mut_pinned.

pub fn call_with<R>(obj: T::Mutable<'a>, f: impl FnOnce(Pin<&mut T>) -> R) -> R

Calls f with a pinned mutable reference to T which is constructed from obj, and returns the value returned by f.

This method exists for consistency (with respect to TempInstMut::call_with), but is actually just a trivial application of Self::new and Self::deref_pin.

Trait Implementations

impl<'a, T: Clone + TempReprMut + 'a> Clone for TempInstPin<'a, T>

where T::Mutable<'a>: Clone,

fn clone(&self) -> TempInstPin<'a, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: TempReprMut + Debug> Debug for TempInstPin<'_, T>

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

Formats the value using the given formatter.

impl<'a, T: TempReprMut<Mutable<'a>: Default>> Default for TempInstPin<'a, T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: TempReprMut> Deref for TempInstPin<'_, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: TempReprMut + Display> Display for TempInstPin<'_, T>

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

Formats the value using the given formatter.

impl<'a, T: Hash + TempReprMut + 'a> Hash for TempInstPin<'a, T>

where T::Mutable<'a>: Hash,

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a, T: Ord + TempReprMut + 'a> Ord for TempInstPin<'a, T>

where T::Mutable<'a>: Ord,

fn cmp(&self, other: &TempInstPin<'a, 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<'a, T: PartialEq + TempReprMut + 'a> PartialEq for TempInstPin<'a, T>

where T::Mutable<'a>: PartialEq,

fn eq(&self, other: &TempInstPin<'a, 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<'a, T: PartialOrd + TempReprMut + 'a> PartialOrd for TempInstPin<'a, T>

where T::Mutable<'a>: PartialOrd,

fn partial_cmp(&self, other: &TempInstPin<'a, 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<'a, T: Copy + TempReprMut + 'a> Copy for TempInstPin<'a, T>

where T::Mutable<'a>: Copy,

impl<'a, T: Eq + TempReprMut + 'a> Eq for TempInstPin<'a, T>

where T::Mutable<'a>: Eq,

impl<'a, T: TempReprMut + 'a> StructuralPartialEq for TempInstPin<'a, T>