Struct Settings 

pub struct Settings {
    pub persistent: bool,
    pub show_track_cover: bool,
    pub notification_static_cover: Option<String>,
    pub cover_path_template: Option<String>,
    pub app_name: Option<String>,
    pub cmus_socket_address: Option<String>,
    pub cmus_socket_password: Option<String>,
    pub link: bool,
    pub force_use_external_cover: bool,
    pub no_use_external_cover: bool,
    pub show_player_notifications: bool,
    /* private fields */
}

Fields

persistent: bool

Make the notification persistent, i.e. not disappear after a timeout (you can dismiss it manually)

show_track_cover: bool

Show the track cover in the notification, if available

notification_static_cover: Option<String>

The static icon to use for the notification, it not effective if the track cover is shown, but if the cover is not available or you disabled it, this icon will be used.

you can give it the full path to an image file or a name of an icon from the current icon theme (e.g. “audio-x-generic” or “spotify-client”)

cover_path_template: Option<String>

The path to look for the cover image, if not given, the cover will be searched in the track’s directory for an image file with the name “cover”.

You can use the placeholder “{artist}” and “{album}” and “{title}” and “{track_number}” and “{disc_number}” and “{year}” and “{genre}” in the path, they will be replaced with the corresponding metadata. but if the metadata is not available, the placeholder will be replaced with an empty string. And you can use the simple glob pattern * to match any character. e.g. “covers/{artist}/{album}/cover.”, “covers/{artist}/{album}/”,

If you not specify the full path, the cover will be started from the track’s directory.

app_name: Option<String>

The name of the app to use for the notification.

cmus_socket_address: Option<String>

The cmus socket address, if not given, the program will use the default socket address, which is “$XDG_RUNTIME_DIR/cmus-socket”.

cmus_socket_password: Option<String>

The cmus socket password, if any.

link: bool

Link the program with cmus, if the cmus are not running, the program will exit.

force_use_external_cover: bool

Force the program to use the external cover file, if available, and not even try to get the cover from the track’s metadata. this is useful if you have a cover file with a better quality than the cover in the track’s metadata.

no_use_external_cover: bool

No use the external cover file, even if it’s available and the track’s metadata doesn’t have a cover.

show_player_notifications: bool

Show the player notifications, like if you change the shuffle mode, or the repeat mode, or the volume.

Implementations

impl Settings

pub fn load_config_and_parse_args() -> Self

Load the config file and parse the args. And combine them together. The args will override the config. If the config file is not found, create a new one, and use the default values. If the config file is found, but the config is invalid, use the default values.

pub fn timeout(&self) -> i32

pub fn app_name(&self) -> String

pub fn interval(&self) -> u64

pub fn depth(&self) -> u8

pub fn remote_bin_path(&self) -> String

pub fn status_notification_summary(&self) -> String

pub fn status_notification_body(&self) -> String

pub fn status_notification_timeout(&self) -> i32

pub fn summary(&self) -> String

pub fn body(&self) -> String

pub fn volume_notification_summary(&self) -> String

pub fn volume_notification_body(&self) -> String

pub fn volume_notification_timeout(&self) -> i32

pub fn shuffle_notification_summary(&self) -> String

pub fn shuffle_notification_body(&self) -> String

pub fn shuffle_notification_timeout(&self) -> i32

pub fn repeat_notification_summary(&self) -> String

pub fn repeat_notification_body(&self) -> String

pub fn repeat_notification_timeout(&self) -> i32

pub fn aaa_mode_notification_summary(&self) -> String

pub fn aaa_mode_notification_body(&self) -> String

pub fn aaa_mode_notification_timeout(&self) -> i32

Trait Implementations

impl Args for Settings

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl CommandFactory for Settings

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Default for Settings

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Settings

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromArgMatches for Settings

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for Settings

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

impl Serialize for Settings

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

where __S: Serializer,

Serialize this value into the given Serde serializer.