Struct Config 

pub struct Config {
    pub cache_dir: PathBuf,
    pub data_dir: PathBuf,
    pub music_dir: PathBuf,
    pub socket_name: String,
    pub addr_claim_mode: AddrClaimMode,
    pub socket_type: SocketType,
    pub playback_config: Config,
}

Configuration options for the daemon.

Used with the start function.

Fields

cache_dir: PathBuf

The directory containing daemon cache.

data_dir: PathBuf

The directory containing the program data, eg. the playlist file.

music_dir: PathBuf

The directory containing the music library/audio files to load.

socket_name: String

The name of the socket to listen on.

This will either resolve to a namespaced socket with the same name, or, in case of a filesystem socket, a file with the same name in the temporary directory.

addr_claim_mode: AddrClaimMode

Defines under which conditions should the daemon claim an occupied socket address.

socket_type: SocketType

Defines the type of socket the daemon should use.

playback_config: Config

Configuration options specific to the playback module.

Implementations

impl Config

pub fn try_default() -> Result<Self, ConfigError>

Get the default daemon config.

For a custom music player, you probably want to create your own config from scratch, or use the Config::try_from_name constructor.

Examples

let conf = chilen_daemon::Config::try_default().unwrap();

pub fn try_from_name(name: &str, socket_name: &str) -> Result<Self, ConfigError>

Create a new config from program and socket names.

The generated paths will contain the name of the program, eg. ~/.cache/<PROGRAM_NAME>, ~/.local/share/<PROGRAM_NAME>.

Fails if the path to the home directory cannot be obtained.

Examples

let conf = chilen_daemon::Config::try_from_name("my-player", "MY_PLAYER");

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Config

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Config

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Config

fn eq(&self, other: &Config) -> 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 Config

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Config

impl StructuralPartialEq for Config