Struct libzettels::Config

pub struct Config {
    pub rootdir: PathBuf,
    pub indexfile: PathBuf,
    pub indexingmethod: IndexingMethod,
    pub sequencestart: SequenceStart,
    pub ignorefile: PathBuf,
}

Config represents the user's configuration. See "Fields" for details of what each value represents. It bundles user specified settings from a configuration file and can be serialized to and deserialized from such a file.

Config derives Serialize and Deserialize via serde and can thus be serialized and deserialized to any format supported by serde. See README.md for details.

The included methods from_file and to_file (de)serialize from/to YAML.

Example

Minimal Configuration file (YAML)

---
rootdir: examples/Zettelkasten
indexfile: examples/index.yaml

Full Configuration file (YAML)

---
rootdir: examples/Zettelkasten
indexfile: examples/index.yaml
indexingmethod: Grep
sequencestart: Keyword
ignorefile: .gitignore

Fields

rootdir: PathBuf

The path to the root directory of the Zettelkasten, i.e. the directory containing the zettel files.

indexfile: PathBuf

The path to the index file.

indexingmethod: IndexingMethod

Optional: Indexing method

Default: IndexingMethod::Native

sequencestart: SequenceStart

Optional: Criteria how libzettels identifies a Zettel as the start of a sequence.

Default: SequenceStart::Keyword

ignorefile: PathBuf

Optional: A file specifying patterns to be ignored by the as gitignore files.

Default: By default, it is .gitignore (because you might manage your Zettelkasten with git). But in case you want different ignore-patterns for git and your Zettelkasten, you can specify an alternative file, here (e.g. .zettelsignore).

Implementations

impl Config

pub fn new<T: AsRef<Path>>(rootdir: T, indexfile: T) -> Config

Creates a new Config by specifying a root directory and a file name for the index file as strings.

Example

let cfg = Config::new("examples/Zettelkasten", 
                      "examples/index.yaml");

assert_eq!(&cfg.rootdir, Path::new("examples/Zettelkasten"));
assert_eq!(&cfg.indexfile, Path::new("examples/index.yaml"));
assert_eq!(&cfg.ignorefile, Path::new(".gitignore"));

pub fn from_file<P: AsRef<Path>>(configfile: P) -> Result<Config, Error>

Creates a new Config by deserializing it from a YAML-file.

Example

let cfg = Config::from_file(Path::new("examples/zettels-examples.cfg.yaml"))?;

Errors

• Error::Io for problems with the specified file.
• Error::Yaml for problems deserializing from YAML.

pub fn to_file<P: AsRef<Path>>(&self, configfile: P) -> Result<(), Error>

Serializes the Config self to a YAML-file.

Example

let cfg = Config::new("examples/Zettelkasten", 
                      "examples/index.yaml");
match cfg.to_file(Path::new("examples/zettels-examples.cfg.yaml")) {
   Ok(_) => println!("Saved config."), 
   Err(error) => panic!("Failed to write config to file. {}", error),
};

Errors

• Error::Io for problems with the specified file.
• Error::Yaml for problems serializing to YAML.

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