Struct PidFile

pub struct PidFile { /* private fields */ }

A PID file is a file that contains the PID of a process. It is used to prevent multiple instances of a process from running at the same time, or to provide a lock for a resource which should only be accessed by one process at a time.

Implementations

impl PidFile

pub fn new(path: impl Into<PathBuf>) -> Result<Self, Error>

Create a new PID file at the given path for this process.

If the PID file already exists, this function will check if the PID file is still in use. If the PID file is in use, this function will return Err(io::ErrorKind::AddrInUse). If the PID file is not in use, it will be removed and a new PID file will be created.

pub fn is_locked(path: &Path) -> Result<bool, Error>

Check if a PID file is in use at this path.

If this function returns an error, it indicates that either the PID file could not be accessed, or when accessed, it contained data which did not look like a PID.

Trait Implementations

impl Debug for PidFile

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

Formats the value using the given formatter.

impl Drop for PidFile

fn drop(&mut self)

Executes the destructor for this type.