Enum LockState 

pub enum LockState {
    Free,
    Held(LockHolder),
    LeaseExpired(LockHolder),
    HolderGone(LockHolder),
    Unreadable,
}

What DirLock::inspect read out of the lock file, having changed nothing to read it.

Variants

Free

There is no lock file: nothing stands between the next writer and the directory.

Held(LockHolder)

A writer holds the directory on a lease it is still renewing.

LeaseExpired(LockHolder)

Nobody renewed the lease within stale_after_ms. It is still this holder’s until the hand-over grace DirLock::acquire owes it has passed.

HolderGone(LockHolder)

The holding process is gone on this host, so nothing is left to renew the lease and the next writer takes the lock outright. Unix only — elsewhere such a lock reads as Held until its lease runs out.

Unreadable

A lock file this engine cannot read: written by an older format, or by something else entirely. It is reclaimed as abandoned once stale_after_ms has passed since it was last touched, so it blocks a writer meanwhile.

Implementations

impl LockState

pub fn holder(&self) -> Option<&LockHolder>

The holder the lock file names, where there is one — None for a directory nobody holds and for a lock file that does not parse.

pub fn blocks_a_writer(&self) -> bool

Whether a writer opening the directory at this moment would have to wait for somebody.

False for LockState::HolderGone as well as LockState::Free: a holder proven dead has nothing left to give notice to, so acquire seizes its lock without waiting at all.

Trait Implementations

impl Clone for LockState

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LockState

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

Formats the value using the given formatter.

impl Eq for LockState

impl PartialEq for LockState

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LockState