[][src]Struct std::pin::Pin

pub struct Pin<P> { /* fields omitted */ }
🔬 This is a nightly-only experimental API. (pin #49150)

A pinned pointer.

This is a wrapper around a kind of pointer which makes that pointer "pin" its value in place, preventing the value referenced by that pointer from being moved unless it implements Unpin.

See the pin module documentation for further explanation on pinning.

Methods

impl<P> Pin<P> where
    P: Deref,
    <P as Deref>::Target: Unpin
[src]

🔬 This is a nightly-only experimental API. (pin #49150)

Construct a new Pin around a pointer to some data of a type that implements Unpin.

impl<P> Pin<P> where
    P: Deref
[src]

🔬 This is a nightly-only experimental API. (pin #49150)

Construct a new Pin around a reference to some data of a type that may or may not implement Unpin.

Safety

This constructor is unsafe because we cannot guarantee that the data pointed to by pointer is pinned. If the constructed Pin<P> does not guarantee that the data P points to is pinned, constructing a Pin<P> is undefined behavior.

If pointer dereferences to an Unpin type, Pin::new should be used instead.

🔬 This is a nightly-only experimental API. (pin #49150)

Get a pinned shared reference from this pinned pointer.

impl<P> Pin<P> where
    P: DerefMut
[src]

🔬 This is a nightly-only experimental API. (pin #49150)

Get a pinned mutable reference from this pinned pointer.

🔬 This is a nightly-only experimental API. (pin #49150)

Assign a new value to the memory behind the pinned reference.

impl<'a, T> Pin<&'a T> where
    T: ?Sized
[src]

🔬 This is a nightly-only experimental API. (pin #49150)

Construct a new pin by mapping the interior value.

For example, if you wanted to get a Pin of a field of something, you could use this to get access to that field in one line of code.

Safety

This function is unsafe. You must guarantee that the data you return will not move so long as the argument value does not move (for example, because it is one of the fields of that value), and also that you do not move out of the argument you receive to the interior function.

Important traits for &'_ mut I

🔬 This is a nightly-only experimental API. (pin #49150)

Get a shared reference out of a pin.

Note: Pin also implements Deref to the target, which can be used to access the inner value. However, Deref only provides a reference that lives for as long as the borrow of the Pin, not the lifetime of the Pin itself. This method allows turning the Pin into a reference with the same lifetime as the original Pin.

impl<'a, T> Pin<&'a mut T> where
    T: ?Sized
[src]

🔬 This is a nightly-only experimental API. (pin #49150)

Convert this Pin<&mut T> into a Pin<&T> with the same lifetime.

Important traits for &'_ mut I

🔬 This is a nightly-only experimental API. (pin #49150)

Get a mutable reference to the data inside of this Pin.

This requires that the data inside this Pin is Unpin.

Note: Pin also implements DerefMut to the data, which can be used to access the inner value. However, DerefMut only provides a reference that lives for as long as the borrow of the Pin, not the lifetime of the Pin itself. This method allows turning the Pin into a reference with the same lifetime as the original Pin.

Important traits for &'_ mut I

🔬 This is a nightly-only experimental API. (pin #49150)

Get a mutable reference to the data inside of this Pin.

Safety

This function is unsafe. You must guarantee that you will never move the data out of the mutable reference you receive when you call this function, so that the invariants on the Pin type can be upheld.

If the underlying data is Unpin, Pin::get_mut should be used instead.

🔬 This is a nightly-only experimental API. (pin #49150)

Construct a new pin by mapping the interior value.

For example, if you wanted to get a Pin of a field of something, you could use this to get access to that field in one line of code.

Safety

This function is unsafe. You must guarantee that the data you return will not move so long as the argument value does not move (for example, because it is one of the fields of that value), and also that you do not move out of the argument you receive to the interior function.

Trait Implementations

impl<P> Copy for Pin<P> where
    P: Copy
[src]

impl<P> Display for Pin<P> where
    P: Display
[src]

Formats the value using the given formatter. Read more

impl<P> Unpin for Pin<P>
[src]

impl<P> DerefMut for Pin<P> where
    P: DerefMut,
    <P as Deref>::Target: Unpin
[src]

Mutably dereferences the value.

impl<P> Hash for Pin<P> where
    P: Hash
[src]

Feeds this value into the given [Hasher]. Read more

Feeds a slice of this type into the given [Hasher]. Read more

impl<P> Deref for Pin<P> where
    P: Deref
[src]

The resulting type after dereferencing.

Dereferences the value.

impl<P> Clone for Pin<P> where
    P: Clone
[src]

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

impl<P> PartialOrd<Pin<P>> for Pin<P> where
    P: PartialOrd<P>, 
[src]

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

This method tests less than (for self and other) and is used by the < operator. Read more

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

This method tests greater than (for self and other) and is used by the > operator. Read more

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

impl<P> Ord for Pin<P> where
    P: Ord
[src]

This method returns an Ordering between self and other. Read more

Compares and returns the maximum of two values. Read more

Compares and returns the minimum of two values. Read more

impl<P> Pointer for Pin<P> where
    P: Pointer
[src]

Formats the value using the given formatter.

impl<P> Eq for Pin<P> where
    P: Eq
[src]

impl<P> Debug for Pin<P> where
    P: Debug
[src]

Formats the value using the given formatter. Read more

impl<P> PartialEq<Pin<P>> for Pin<P> where
    P: PartialEq<P>, 
[src]

This method tests for self and other values to be equal, and is used by ==. Read more

This method tests for !=.

impl<P, U> CoerceUnsized<Pin<U>> for Pin<P> where
    P: CoerceUnsized<U>, 
[src]

impl<P> Future for Pin<P> where
    P: DerefMut,
    <P as Deref>::Target: Future
[src]

🔬 This is a nightly-only experimental API. (futures_api #50547)

futures in libcore are unstable

The result of the Future.

🔬 This is a nightly-only experimental API. (futures_api #50547)

futures in libcore are unstable

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. Read more

impl<T> From<Box<T>> for Pin<Box<T>>
[src]

Performs the conversion.

Auto Trait Implementations

impl<P> Send for Pin<P> where
    P: Send

impl<P> Sync for Pin<P> where
    P: Sync

Blanket Implementations

impl<T, U> TryFrom for T where
    T: From<U>, 
[src]

🔬 This is a nightly-only experimental API. (try_from #33417)

The type returned in the event of a conversion error.

🔬 This is a nightly-only experimental API. (try_from #33417)

Performs the conversion.

impl<T> From for T
[src]

Performs the conversion.

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

🔬 This is a nightly-only experimental API. (try_from #33417)

The type returned in the event of a conversion error.

🔬 This is a nightly-only experimental API. (try_from #33417)

Performs the conversion.

impl<T, U> Into for T where
    U: From<T>, 
[src]

Performs the conversion.

impl<T> Borrow for T where
    T: ?Sized
[src]

Important traits for &'_ mut I

Immutably borrows from an owned value. Read more

impl<T> BorrowMut for T where
    T: ?Sized
[src]

Important traits for &'_ mut I

Mutably borrows from an owned value. Read more

impl<T> Any for T where
    T: 'static + ?Sized
[src]

🔬 This is a nightly-only experimental API. (get_type_id #27745)

this method will likely be replaced by an associated static

Gets the TypeId of self. Read more

impl<T> ToOwned for T where
    T: Clone
[src]

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into #41263)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T where
    T: Display + ?Sized
[src]

Converts the given value to a String. Read more