Skip to main content

PidFile

Struct PidFile 

Source
pub struct PidFile { /* private fields */ }
Expand description

RAII handle for a pidfile we currently own. Releases on Drop.

Dropping removes the file only if its contents still match our pid — so a second daemon that stole the lock (e.g. after we crashed) doesn’t get its pidfile deleted out from under it when we eventually unwind.

Implementations§

Source§

impl PidFile

Source

pub fn acquire(path: impl Into<PathBuf>) -> Result<Self, LockError>

Try to take the pidfile at path. On success, our pid is written to disk and held until drop.

If a previous pidfile exists and that pid is still alive, Err(LockError::HeldBy) is returned and the file is left untouched. A stale pidfile (dead pid) is silently replaced.

Source

pub fn path(&self) -> &Path

Source

pub fn pid(&self) -> u32

Source

pub fn release(self) -> Result<()>

Explicitly release the pidfile now. Equivalent to letting it drop, except the caller can observe the io error instead of swallowing it.

Trait Implementations§

Source§

impl Debug for PidFile

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Drop for PidFile

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more