Struct spirit_daemonize::Daemon

pub struct Daemon {
    pub user: SecId,
    pub group: SecId,
    pub pid_file: Option<PathBuf>,
    pub workdir: Option<PathBuf>,
    pub daemonize: bool,
    // some fields omitted
}

A configuration fragment for configuration of daemonization.

This describes how to go into background with some details.

The fields can be manipulated by the user of this crate. However, it is not possible to create the struct manually. This is on purpose, some future versions might add more fields. If you want to create one, use Daemon::default and modify certain fields as needed.

Examples

let mut daemon = Daemon::default();
daemon.workdir = Some("/".into());

See also

If you want to daemonize, but not to switch users (or allow switching users), either because the daemon needs to keep root privileges or because it is expected to be already started as ordinary user, use the UserDaemon instead.

Fields

user: SecId

The user to drop privileges to.

The user is not changed if not provided.

group: SecId

The group to drop privileges to.

The group is not changed if not provided.

pid_file: Option<PathBuf>

Where to store a PID file.

If not set, no PID file is created.

workdir: Option<PathBuf>

Switch to this working directory at startup.

If not set, working directory is not switched.

daemonize: bool

Enable the daemonization.

Even if this is false, some activity (changing users, setting PID file, etc) is still done, but it doesn't go to background.

Methods

impl Daemon

pub fn daemonize(&self) -> Result<(), Error>

Goes into background according to the configuration.

This does the actual work of daemonization. This can be used manually.

pub fn extension<E, F>(extractor: F) -> impl Extension<E> where
    E: Extensible<Ok = E>,
    F: Fn(&E::Config, &E::Opts) -> Self + Send + 'static, 

An extension that can be plugged into the Spirit.

See the crate documentation.

Trait Implementations

impl Eq for Daemon

impl PartialEq<Daemon> for Daemon

fn eq(&self, other: &Daemon) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Daemon) -> bool

This method tests for !=.

impl Clone for Daemon

fn clone(&self) -> Daemon

Returns a copy of the value.

default fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for Daemon

fn default() -> Daemon

Returns the "default value" for a type.

impl From<UserDaemon> for Daemon

fn from(ud: UserDaemon) -> Daemon

Performs the conversion.

impl Debug for Daemon

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

Formats the value using the given formatter.

impl Serialize for Daemon

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Daemon

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl StructDoc for Daemon

fn document() -> Documentation

Returns the documentation for the type.