Skip to main content

WaitSet

Struct WaitSet 

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

WaitSet — Spec §2.2.2.1.6.

A WaitSet collects 0..N Arc<dyn Condition> and blocks in Self::wait until at least one triggers or a timeout is reached. Returns the list of triggered conditions.

Implementations§

Source§

impl WaitSet

Source

pub fn new() -> Self

New empty WaitSet.

Source

pub fn attach_condition(&self, cond: Arc<dyn Condition>) -> Result<()>

Attaches a condition. Spec §2.2.2.1.6 attach_condition.

§Errors

PreconditionNotMet if the internal lock is poisoned.

Source

pub fn detach_condition(&self, cond: &Arc<dyn Condition>) -> Result<()>

Detaches a condition. Spec §2.2.2.1.6 detach_condition.

§Errors

PreconditionNotMet if the internal lock is poisoned.

Source

pub fn get_conditions(&self) -> Result<Vec<Arc<dyn Condition>>>

Current set of attached conditions.

§Errors

PreconditionNotMet on lock poisoning.

Source

pub fn wait(&self, timeout: Duration) -> Result<Vec<Arc<dyn Condition>>>

Blocks until at least one condition triggers or the timeout elapses. Returns the list of triggered conditions. Spec §2.2.2.1.6 wait.

Implementation: polling at a 1ms interval. A production- grade WaitSet would offer conditions notify hooks; that is a follow-up optimization.

§Errors
Source

pub fn notify(&self)

Wakes a blocked wait() without a trigger_value change having occurred (e.g. for shutdown).

Currently this only has an effect if the WaitSet is blocked in wait_timeout — the caller should still attach a GuardCondition so that the wakeup has a definite result.

Trait Implementations§

Source§

impl Clone for WaitSet

Available on crate feature std only.
Source§

fn clone(&self) -> Self

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 WaitSet

Available on crate feature std only.
Source§

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

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

impl Default for WaitSet

Available on crate feature std only.
Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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.