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.
🔬 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
.
🔬 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
.
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.
🔬 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.
🔬 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.
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.
🔬 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
.
🔬 This is a nightly-only experimental API. (
pin
#49150)
Convert this Pin<&mut T>
into a Pin<&T>
with the same lifetime.
🔬 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
.
🔬 This is a nightly-only experimental API. (
pin
#49150)
Get a mutable reference to the data inside of this Pin
.
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.
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.
The resulting type after dereferencing.
Mutably dereferences the value.
This method tests for self
and other
values to be equal, and is used by ==
. Read more
This method tests for !=
.
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
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
Performs copy-assignment from source
. Read more
Feeds this value into the given [Hasher
]. Read more
Feeds a slice of this type into the given [Hasher
]. Read more
Formats the value using the given formatter. Read more
Formats the value using the given formatter. Read more
Formats the value using the given formatter.
🔬 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
🔬 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)
🔬 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)
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more
🔬 This is a nightly-only experimental API. (get_type_id
#27745)
this method will likely be replaced by an associated static