Struct FileLock

Source

pub struct FileLock { /* private fields */ }

Expand description

A held exclusive file lock. Released on drop.

Implementations§

Source §

impl FileLock

Source

pub fn try_acquire(path: &Path) -> Result<Option<FileLock>>

Non-blocking. Ok(Some) if acquired now, Ok(None) if another holder has it.

Source

pub fn acquire_blocking(path: &Path) -> Result<FileLock>

Blocks until acquired. Use only watcher-to-watcher; interactive callers use FileLock::acquire_timeout so a hung holder can’t hang git checkout.

Source

pub fn acquire_timeout( path: &Path, timeout: Duration, ) -> Result<Option<FileLock>>

Polls until acquired or timeout elapses; Ok(None) on timeout (caller should warn-skip).

Trait Implementations§

Source §

impl Debug for FileLock

Source §

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl UnwindSafe for FileLock

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source §

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §