Struct timelog::config::Config

pub struct Config { /* private fields */ }

Type specifying the configuration for the timelog program.

Implementations

impl Config

pub fn new(
    config: &str,
    dir: Option<&str>,
    editor: Option<&str>,
    browser: Option<&str>,
    cmd: Option<&str>
) -> Result<Self>

Create a new Config object with supplied parameters

Errors

• Return PathError::InvalidConfigPath if the configuration filename is not valid.
• Return PathError::InvalidTimelogPath if the timelog directory is not valid.

pub fn from_file(filename: &str) -> Result<Self>

Create a new Config object from the supplied config file

Errors

• Return PathError::InvalidConfigPath if the configuration filename is not valid.
• Return PathError::InvalidTimelogPath if the timelog directory is not valid.
• Return PathError::FileAccess if the config file is not accessible.

pub fn configfile(&self) -> &str

Return a String containing the name of the config file.

pub fn dir(&self) -> &str

Return the path of the directory that stores the log and stack files

pub fn set_dir(&mut self, dir: &str)

Set the path of the directory that stores the log and stack files

pub fn editor(&self) -> &str

Return the path to the editor used with the edit command

pub fn set_editor(&mut self, editor: &str)

Set the path to the editor used with the edit command

pub fn browser(&self) -> &str

The path to the browser used with the chart command

pub fn set_browser(&mut self, browser: &str)

The path to the browser used with the chart command

pub fn defcmd(&self) -> &str

Return the default command if none is entered

pub fn logfile(&self) -> String

The file containing the timelog entries

pub fn stackfile(&self) -> String

The file that holds the stack

pub fn reportfile(&self) -> String

The file containing the timelog entries

pub fn create(&self) -> Result<(), PathError>

Write the configuration to disk in the file specified by the Config

Errors

• Return PathError::FileAccess if we are unable to write the configuration.

pub fn alias_names(&self) -> impl Iterator<Item = &String>

Return an iterator over the alias names

pub fn alias(&self, key: &str) -> Option<&String>

Retrieve the value associate with the named alias, if one exists.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy 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 Default for Config

fn default() -> Self

Create a Config with all of the default parameters.

Panics

If any of the default valures are not legal in the current system, the code will panic. These is a programmer-specified defaults, and should never fail.

impl PartialEq<Config> for Config

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

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

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

This method tests for !=.

impl StructuralPartialEq for Config