Struct spirit_daemonize::UserDaemon

#[non_exhaustive]pub struct UserDaemon {
    pub pid_file: Option<PathBuf>,
    pub workdir: Option<PathBuf>,
    pub daemonize: bool,
}

A stripped-down version of Daemon without the user-switching options.

Sometimes, the daemon either needs to keep the root privileges or is started with the appropriate user right away, therefore the user should not be able to configure the user and group options.

This configuration fragment serves the role. Convert it to Daemon first, by into_daemon (or using the Into trait).

Examples

use spirit_daemonize::{Daemon, UserDaemon};

// No way to access the `pid_file` and others inside this thing and can't call `.daemonize()`.
let user_daemon = UserDaemon::default();

let daemon: Daemon = user_daemon.into();
assert!(daemon.pid_file.is_none());
assert_eq!(daemon, Daemon::default());

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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 (setting PID file, etc) is still done, but it doesn't go to background.

Implementations

impl UserDaemon

pub fn into_daemon(self) -> Daemon

Converts to full-featured Daemon.

All the useful functionality is on Daemon, therefore to use it, convert it first.

It can be also converted using the usual From/Into traits.

Trait Implementations

impl Clone for UserDaemon

pub fn clone(&self) -> UserDaemon

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UserDaemon

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

Formats the value using the given formatter.

impl Default for UserDaemon

pub fn default() -> UserDaemon

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for UserDaemon

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

Deserialize this value from the given Serde deserializer.

impl Eq for UserDaemon

impl From<UserDaemon> for Daemon

pub fn from(ud: UserDaemon) -> Daemon

Performs the conversion.

impl PartialEq<UserDaemon> for UserDaemon

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

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

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

This method tests for !=.

impl Serialize for UserDaemon

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

Serialize this value into the given Serde serializer.

impl StructDoc for UserDaemon

pub fn document() -> Documentation

Returns the documentation for the type.

impl StructuralEq for UserDaemon

impl StructuralPartialEq for UserDaemon