pub struct AcquireOwned<Lock = Spinlock>
where Lock: RawMutex,
{ /* private fields */ }
Available on crate feature alloc only.
Expand description

Future returned from Semaphore::acquire_owned().

This is identical to the Acquire future, except that it takes an Arc reference to the Semaphore, allowing the returned future to live for the 'static lifetime, and returns an OwnedPermit (rather than a Permit), which is also valid for the 'static lifetime.

Notes

This future is !Unpin, as it is unsafe to core::mem::forget an AcquireOwned future once it has been polled. For instance, the following code must not compile:

 use maitake_sync::semaphore::AcquireOwned;

 // Calls to this function should only compile if `T` is `Unpin`.
 fn assert_unpin<T: Unpin>() {}

 assert_unpin::<AcquireOwned<'_>>();

Trait Implementations§

source§

impl<Lock> Debug for AcquireOwned<Lock>
where Lock: Debug + RawMutex,

source§

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

Formats the value using the given formatter. Read more
source§

impl<Lock> Drop for AcquireOwned<Lock>
where Lock: RawMutex,

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl<Lock> Future for AcquireOwned<Lock>
where Lock: RawMutex,

§

type Output = Result<OwnedPermit<Lock>, Closed>

The type of value produced on completion.
source§

fn poll( self: Pin<&mut AcquireOwned<Lock>>, cx: &mut Context<'_> ) -> Poll<<AcquireOwned<Lock> as Future>::Output>

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

impl<Lock> Sync for AcquireOwned<Lock>
where Lock: RawMutex,

source§

impl<'pin, Lock> Unpin for AcquireOwned<Lock>
where Lock: RawMutex, __AcquireOwned<'pin, Lock>: Unpin,

Auto Trait Implementations§

§

impl<Lock = Spinlock> !RefUnwindSafe for AcquireOwned<Lock>

§

impl<Lock> Send for AcquireOwned<Lock>
where Lock: Sync + Send,

§

impl<Lock = Spinlock> !UnwindSafe for AcquireOwned<Lock>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<F> IntoFuture for F
where F: Future,

§

type Output = <F as Future>::Output

The output that the future will produce on completion.
§

type IntoFuture = F

Which kind of future are we turning this into?
source§

fn into_future(self) -> <F as IntoFuture>::IntoFuture

Creates a future from a value. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more