Struct Shared 

pub struct Shared {
    pub pueue_directory: Option<PathBuf>,
    pub runtime_directory: Option<PathBuf>,
    pub alias_file: Option<PathBuf>,
    pub use_unix_socket: bool,
    pub unix_socket_path: Option<PathBuf>,
    pub unix_socket_permissions: Option<u32>,
    pub host: String,
    pub port: String,
    pub pid_path: Option<PathBuf>,
    pub daemon_cert: Option<PathBuf>,
    pub daemon_key: Option<PathBuf>,
    pub shared_secret_path: Option<PathBuf>,
}

All settings which are used by both, the client and the daemon

Fields

pueue_directory: Option<PathBuf>

Don’t access this property directly, but rather use the getter with the same name. It’s only public to allow proper integration testing.

The directory that is used for all of pueue’s state.
I.e. task logs, state dumps, etc.

runtime_directory: Option<PathBuf>

Don’t access this property directly, but rather use the getter with the same name. It’s only public to allow proper integration testing.

The location where runtime related files will be placed. Defaults to pueue_directory unless $XDG_RUNTIME_DIR is set.

alias_file: Option<PathBuf>

Don’t access this property directly, but rather use the getter with the same name. It’s only public to allow proper integration testing.

The location of the alias file used by the daemon/client when working with aliases.

use_unix_socket: bool

If this is set to true, unix sockets will be used. Otherwise we default to TCP+TLS

unix_socket_path: Option<PathBuf>

Don’t access this property directly, but rather use the getter with the same name. It’s only public to allow proper integration testing.

The path to the unix socket.

unix_socket_permissions: Option<u32>

Unix socket permissions. Typically specified as an octal number and defaults to 0o700 which grants only the current user access to the socket. For a client to connect to the daemon, the client must have read/write permissions.

host: String

The TCP hostname/ip address.

port: String

The TCP port.

pid_path: Option<PathBuf>

The path where the daemon’s PID is located. This is by default in runtime_directory/pueue.pid.

daemon_cert: Option<PathBuf>

Don’t access this property directly, but rather use the getter with the same name. It’s only public to allow proper integration testing.

The path to the TLS certificate used by the daemon.
This is also used by the client to verify the daemon’s identity.

daemon_key: Option<PathBuf>

Don’t access this property directly, but rather use the getter with the same name. It’s only public to allow proper integration testing.

The path to the TLS key used by the daemon.

shared_secret_path: Option<PathBuf>

Don’t access this property directly, but rather use the getter with the same name. It’s only public to allow proper integration testing.

The path to the file containing the shared secret used to authenticate the client.

Implementations

impl Shared

pub fn pueue_directory(&self) -> PathBuf

pub fn runtime_directory(&self) -> PathBuf

Get the current runtime directory in the following precedence.

1. Config value
2. Environment configuration
3. Pueue directory

pub fn unix_socket_path(&self) -> PathBuf

The unix socket path can either be explicitly specified or it’s simply placed in the current runtime directory.

pub fn alias_file(&self) -> PathBuf

The location of the alias file used by the daemon/client when working with task aliases.

pub fn pid_path(&self) -> PathBuf

The daemon’s pid path can either be explicitly specified or it’s simply placed in the current runtime directory.

pub fn daemon_cert(&self) -> PathBuf

pub fn daemon_key(&self) -> PathBuf

pub fn shared_secret_path(&self) -> PathBuf

Trait Implementations

impl Clone for Shared

fn clone(&self) -> Shared

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Shared

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

Formats the value using the given formatter.

impl Default for Shared

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Shared

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Shared

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Shared

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Shared> for ConnectionSettings<'_>

Available on crate feature settings only.

Convenience conversion from Shared to ConnectionSettings.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Shared) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Shared> for ConnectionSettings<'_>

Available on crate feature settings only.

Convenience conversion from Shared to ConnectionSettings.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Shared) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Shared

impl StructuralPartialEq for Shared