Skip to main content

EmbeddedLocalAutoResetEventRef

Struct EmbeddedLocalAutoResetEventRef 

Source
pub struct EmbeddedLocalAutoResetEventRef { /* private fields */ }
Expand description

Handle to an embedded LocalAutoResetEvent.

Created via LocalAutoResetEvent::embedded(). The caller is responsible for ensuring the EmbeddedLocalAutoResetEvent outlives all handles and wait futures.

The API is identical to LocalAutoResetEvent.

Implementations§

Source§

impl EmbeddedLocalAutoResetEventRef

Source

pub fn set(&self)

Signals the event, releasing at most one waiter.

If one or more waiters are registered, a single waiter is released and the event remains unset. If no one is waiting, the event transitions to the set state.

Source

pub fn try_wait(&self) -> bool

Attempts to consume the signal without blocking.

Returns true if the event was set, transitioning it back to the unset state. Returns false if the event was not set.

Source

pub fn wait(&self) -> EmbeddedLocalAutoResetWaitFuture

Returns a future that completes when the event is signaled.

Trait Implementations§

Source§

impl Clone for EmbeddedLocalAutoResetEventRef

Source§

fn clone(&self) -> EmbeddedLocalAutoResetEventRef

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EmbeddedLocalAutoResetEventRef

Source§

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

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

impl Copy for EmbeddedLocalAutoResetEventRef

Source§

impl RefUnwindSafe for EmbeddedLocalAutoResetEventRef

Source§

impl UnwindSafe for EmbeddedLocalAutoResetEventRef

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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<T> ToOwned for T
where T: Clone,

Source§

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<U> for T
where U: Into<T>,

Source§

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>,

Source§

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.