Struct pid_file::PidFile

pub struct PidFile(pub(crate) *mut pidfh);

An open PID file.

A process that manages to construct this type holds an exclusive lock on the PID file.

Dropping the type will attempt to call remove, but any errors will be suppressed. Call remove manually if you need to handle PID file removal errors.

Tuple Fields

0: *mut pidfh

Implementations

impl PidFile

pub fn open<P>(path: P) -> Result<PidFile, Error> where
    P: AsRef<Path>, 

Attempts to open and lock the specified PID file.

If the file is already locked by another process, it returns Error::AlreadyRunning.

pub fn open_with<P>(path: P, permissions: Permissions) -> Result<PidFile, Error> where
    P: AsRef<Path>, 

Like open, but opens the file with the specified permissions rather than 0600.

pub fn remove(self) -> Result<(), Error>

Closes the PID file and removes it from the filesystem.

Trait Implementations

impl Drop for PidFile

fn drop(&mut self)

Executes the destructor for this type.