Struct otter_nodejs_tests::inventory::core::task::Waker

1.36.0 · source · [−]

#[repr(transparent)]
pub struct Waker { /* private fields */ }

Expand description

A Waker is a handle for waking up a task by notifying its executor that it is ready to be run.

This handle encapsulates a RawWaker instance, which defines the executor-specific wakeup behavior.

Implements Clone, Send, and Sync.

Implementations

source

impl Waker

source

pub fn wake(self)

Wake up the task associated with this Waker.

As long as the runtime keeps running and the task is not finished, it is guaranteed that each invocation of wake (or wake_by_ref) will be followed by at least one poll of the task to which this Waker belongs. This makes it possible to temporarily yield to other tasks while running potentially unbounded processing loops.

Note that the above implies that multiple wake-ups may be coalesced into a single poll invocation by the runtime.

Also note that yielding to competing tasks is not guaranteed: it is the executor’s choice which task to run and the executor may choose to run the current task again.

source

pub fn wake_by_ref(&self)

Wake up the task associated with this Waker without consuming the Waker.

This is similar to wake, but may be slightly less efficient in the case where an owned Waker is available. This method should be preferred to calling waker.clone().wake().

source

pub fn will_wake(&self, other: &Waker) -> bool

Returns true if this Waker and another Waker have awoken the same task.

This function works on a best-effort basis, and may return false even when the Wakers would awaken the same task. However, if this function returns true, it is guaranteed that the Wakers will awaken the same task.

This function is primarily used for optimization purposes.

source

pub unsafe fn from_raw(waker: RawWaker) -> Waker

Creates a new Waker from RawWaker.

The behavior of the returned Waker is undefined if the contract defined in RawWaker’s and RawWakerVTable’s documentation is not upheld. Therefore this method is unsafe.

source

pub fn as_raw(&self) -> &RawWaker

🔬 This is a nightly-only experimental API. (waker_getters)

Get a reference to the underlying RawWaker.

Trait Implementations

source

impl Clone for Waker

source

fn clone(&self) -> Waker

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for Waker

source

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

Formats the value using the given formatter. Read more

source

impl Drop for Waker

source

fn drop(&mut self)

Executes the destructor for this type. Read more

1.51.0 · source

impl<W> From<Arc<W>> for Waker where
W: 'static + Wake + Send + Sync,

source

fn from(waker: Arc<W>) -> Waker

Use a Wake-able type as a Waker.

No heap allocations or atomic operations are used for this conversion.

source

impl Send for Waker

source

impl Sync for Waker

source

impl Unpin for Waker

Auto Trait Implementations

impl RefUnwindSafe for Waker

impl UnwindSafe for Waker

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> DebugExt<T> for T where
T: Debug,

fn to_debug(&self) -> String

impl<T> Downcast for T where
T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>ⓘNotable traits for Box<W, Global>`impl<W> Write for Box<W, Global> where W: Write + ?Sized, impl<R> Read for Box<R, Global> where R: Read + ?Sized, impl<F, A> Future for Box<F, A> where F: Future + Unpin + ?Sized, A: Allocator + 'static, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where I: Iterator + ?Sized, A: Allocator, type Item = ::Item;`

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

impl<T> DowncastSync for T where
T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

impl<A> DynCastExt for A

fn dyn_cast<T>(
 self
) -> Result<<A as DynCastExtHelper<T>>::Target, <A as DynCastExtHelper<T>>::Source> where
 A: DynCastExtHelper<T>,
 T: ?Sized,

Use this to cast from one trait object type to another. Read more

fn dyn_upcast<T>(self) -> <A as DynCastExtAdvHelper<T, T>>::Target where
A: DynCastExtAdvHelper<T, T, Source = <A as DynCastExtAdvHelper<T, T>>::Target>,
T: ?Sized,

Use this to upcast a trait to one of its supertraits. Read more

fn dyn_cast_adv<F, T>(
 self
) -> Result<<A as DynCastExtAdvHelper<F, T>>::Target, <A as DynCastExtAdvHelper<F, T>>::Source> where
 A: DynCastExtAdvHelper<F, T>,
 F: ?Sized,
 T: ?Sized,

Use this to cast from one trait object type to another. This method is more customizable than the dyn_cast method. Here you can also specify the “source” trait from which the cast is defined. This can for example allow using casts from a supertrait of the current trait object. Read more

fn dyn_cast_with_config<C>(
 self
) -> Result<<A as DynCastExtAdvHelper<<C as DynCastConfig>::Source, <C as DynCastConfig>::Target>>::Target, <A as DynCastExtAdvHelper<<C as DynCastConfig>::Source, <C as DynCastConfig>::Target>>::Source> where
 C: DynCastConfig,
 A: DynCastExtAdvHelper<<C as DynCastConfig>::Source, <C as DynCastConfig>::Target>,

Use this to cast from one trait object type to another. With this method the type parameter is a config type that uniquely specifies which cast should be preformed. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

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

source

fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

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

source

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

const: unstable · 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<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

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

source

fn clone_into(&self, target: &mut T)

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;` where
S: Into<Dispatch>,

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

source

fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;`

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

Struct otter_nodejs_tests::inventory::core::task::Waker

Implementations

impl Waker

pub fn wake(self)

pub fn wake_by_ref(&self)

pub fn will_wake(&self, other: &Waker) -> bool

pub unsafe fn from_raw(waker: RawWaker) -> Waker

pub fn as_raw(&self) -> &RawWaker

Trait Implementations

impl Clone for Waker

fn clone(&self) -> Waker

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

impl Debug for Waker

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

impl Drop for Waker

fn drop(&mut self)

impl<W> From<Arc<W>> for Waker where W: 'static + Wake + Send + Sync,

fn from(waker: Arc<W>) -> Waker

impl Send for Waker

impl Sync for Waker

impl Unpin for Waker

Auto Trait Implementations

impl RefUnwindSafe for Waker

impl UnwindSafe for Waker

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> DebugExt<T> for T where T: Debug,

fn to_debug(&self) -> String

impl<T> Downcast for T where T: Any,

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

fn as_any(&self) -> &(dyn Any + 'static)

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

impl<T> DowncastSync for T where T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync + 'static>

impl<A> DynCastExt for A

fn dyn_cast<T>( self) -> Result<<A as DynCastExtHelper<T>>::Target, <A as DynCastExtHelper<T>>::Source> where A: DynCastExtHelper<T>, T: ?Sized,

fn dyn_upcast<T>(self) -> <A as DynCastExtAdvHelper<T, T>>::Target where A: DynCastExtAdvHelper<T, T, Source = <A as DynCastExtAdvHelper<T, T>>::Target>, T: ?Sized,

fn dyn_cast_adv<F, T>( self) -> Result<<A as DynCastExtAdvHelper<F, T>>::Target, <A as DynCastExtAdvHelper<F, T>>::Source> where A: DynCastExtAdvHelper<F, T>, F: ?Sized, T: ?Sized,

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;

fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;

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

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

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

type Error = Infallible

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

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

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

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

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output; where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;

impl<W> From<Arc<W>> for Waker where
W: 'static + Wake + Send + Sync,

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

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

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

impl<T> DebugExt<T> for T where
T: Debug,

impl<T> Downcast for T where
T: Any,

impl<T> DowncastSync for T where
T: Any + Send + Sync,

fn dyn_cast<T>(
self
) -> Result<<A as DynCastExtHelper<T>>::Target, <A as DynCastExtHelper<T>>::Source> where
A: DynCastExtHelper<T>,
T: ?Sized,

fn dyn_upcast<T>(self) -> <A as DynCastExtAdvHelper<T, T>>::Target where
A: DynCastExtAdvHelper<T, T, Source = <A as DynCastExtAdvHelper<T, T>>::Target>,
T: ?Sized,

fn dyn_cast_adv<F, T>(
self
) -> Result<<A as DynCastExtAdvHelper<F, T>>::Target, <A as DynCastExtAdvHelper<F, T>>::Source> where
A: DynCastExtAdvHelper<F, T>,
F: ?Sized,
T: ?Sized,

fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

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

impl<T> ToOwned for T where
T: Clone,

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

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

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;` where
S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;`