Struct RecursiveLock

struct RecursiveLock {
    lock: Option<FileLock>,
    count: u32,
    is_exclusive: bool,
    filename: &'static str,
}

A file lock, with a counter to assist with recursive locking.

Fields

lock: Option<FileLock>

The file lock.

An important note is that locks can be None even when they are held. This can happen on things like old NFS mounts where locking isn’t supported. We otherwise pretend we have a lock via the lock count. See FileLock for more detail on that.

count: u32

Number locks held, to support recursive locking.

is_exclusive: bool

If this is true, it is an exclusive lock, otherwise it is shared.

filename: &'static str

The filename of the lock.

Implementations

impl RecursiveLock

fn new(filename: &'static str) -> RecursiveLock

fn increment(&mut self)

Low-level lock count increment routine.

fn decrement(&mut self)

Unlocks a previously acquired lock.

fn lock_shared( &mut self, gctx: &GlobalContext, description: &'static str, blocking: BlockingMode, ) -> LockingResult

Acquires a shared lock.

fn lock_shared_blocking( &mut self, gctx: &GlobalContext, description: &'static str, )

Acquires a shared lock, blocking if held by another locker.

fn lock_shared_nonblocking(&mut self, gctx: &GlobalContext) -> LockingResult

Acquires a shared lock, returns WouldBlock if held by another locker.

fn lock_exclusive( &mut self, gctx: &GlobalContext, description: &'static str, blocking: BlockingMode, ) -> CargoResult<LockingResult>

Acquires an exclusive lock.

fn lock_exclusive_blocking( &mut self, gctx: &GlobalContext, description: &'static str, ) -> CargoResult<()>

Acquires an exclusive lock, blocking if held by another locker.

fn lock_exclusive_nonblocking( &mut self, gctx: &GlobalContext, ) -> CargoResult<LockingResult>

Acquires an exclusive lock, returns WouldBlock if held by another locker.

Trait Implementations

impl Debug for RecursiveLock

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

Formats the value using the given formatter.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 56 bytes