Struct Lever

pub struct Lever { /* private fields */ }

A lever that can raise and lower the gate it’s associated with

Implementations

impl Lever

pub fn raise(&self) -> Result<(), GateDropped>

Raise the gate. This wakes all tasks waiting on Gate::raised (and later calls to it will resolve immediately until the gate is lowered).

Errors

If the gate was dropped, an Err is returned.

pub fn lower(&self) -> Result<(), GateDropped>

Lower the gate. This wakes all tasks waiting on Gate::lowered (and later calls to it will resolve immediately until the gate is raised).

Errors

If the gate was dropped, an Err is returned.

pub fn is_raised(&self) -> Result<bool, BeforeGateDropped>

Returns Ok(true) if the gate is raised and Ok(false) if it’s lowered,

Errors

If the gate was dropped and was raised before dropping, an Err(BeforeGateDropped(Raised)) is returned. Likewise, if the gate was dropped and was lowered before dropping, an Err(BeforeGateDropped(Lowered)) is returned.

pub fn is_lowered(&self) -> Result<bool, BeforeGateDropped>

Returns Ok(true) if the gate is lowered and Ok(false) if it’s raised.

Errors

If the gate was dropped and was lowered before dropping, an Err(BeforeGateDropped(Lowered)) is returned. Likewise, if the gate was dropped and was raised before dropping, an Err(BeforeGateDropped(Raised)) .

pub fn gate_was_dropped(&self) -> bool

Returns true if the gate associated with this lever has been dropped and false if it hasn’t.

Trait Implementations

impl Clone for Lever

fn clone(&self) -> Lever

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Lever

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

Formats the value using the given formatter.