Struct jarida::Config

pub struct Config {
    pub temp_dir: Option<PathBuf>,
    pub journal_dir: Option<PathBuf>,
    pub editor: PathBuf,
    pub user: Option<String>,
    pub password: Option<String>,
}

Fields

temp_dir: Option<PathBuf>

The temporary work directory

journal_dir: Option<PathBuf>

The directory to save all journal data in

editor: PathBuf

The path to the user’s editor of choice

user: Option<String>

The name of the user

password: Option<String>

Password

Implementations

impl Config

pub const DIR_NAME: &'static str

The name of the configuration directory.

pub const FILE_NAME: &'static str

The name of the configuration file.

pub fn find() -> Result<Config>

Find the configuration file and parse it.

Returns an error if the file cannot be found or is invalid/malformed.

pub fn find_config_file_path() -> Result<PathBuf>

Try to find the config file, first in a parent directory, then in the user’s home directory. The file may not exist.

An error is returned if the configuration directory cannot be found.

pub fn find_config_dir_path() -> Result<PathBuf>

Try to find the config directory, first in a parent directory, then in the user’s home directory. If the directory cannot be found an error is returned/

pub fn get_user_config_dir_path() -> Result<PathBuf>

Get the expected path to the config direcotry in the user’s home directory.

The file may not exist. If the user’s home directory could not be found an error is returned.

pub fn data_store_path(&self) -> PathBuf

Get the path to the directory containing journal data.

pub fn template() -> &'static str

Get the contents of a template config.toml file.

Trait Implementations

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 FromStr for Config

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Config, Self::Err>

Parses a string s to return a value of this type.