Struct LockGate 

pub struct LockGate { /* private fields */ }

The lock-state safety gate.

Implementations

impl LockGate

pub fn new() -> Self

An unlocked gate.

pub fn state(&self) -> LockState

The current lock state.

pub fn is_locked(&self) -> bool

Whether the behaviour is locked (acquiring or tracking). commanding (a behaviour actually driving the FC) additionally requires the stream to be usable this cycle; the session combines the two.

pub fn lock(&mut self)

Explicitly acquire (or re-acquire) the lock, an operator designate. This is the ONLY transition out of Lost.

pub fn unlock(&mut self)

Release the lock (back to idle).

pub fn update(&mut self, stream_usable: bool)

Advance the gate for one cycle given whether the underlying stream is usable (fresh + link up). A Locked gate that HAS been usable and then is not drops to Lost; a Locked gate still acquiring (never usable yet) stays Locked. A Lost gate stays Lost even when the stream becomes usable again, it never auto-re-acquires.

Trait Implementations

impl Clone for LockGate

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for LockGate

impl Debug for LockGate

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

Formats the value using the given formatter.

impl Default for LockGate

fn default() -> Self

Returns the “default value” for a type.

impl Eq for LockGate

impl PartialEq for LockGate

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for LockGate