Struct LibCfg

pub struct LibCfg {
    pub scheme_sync_default: String,
    pub scheme: Vec<Scheme>,
    pub tmpl_html: TmplHtml,
}

Processed configuration data.

Its structure is different form the input form defined in LibCfgRaw (see example in LIB_CONFIG_DEFAULT_TOML). For conversion use:

use tpnote_lib::config::LIB_CONFIG_DEFAULT_TOML;
use tpnote_lib::config::LibCfg;
use tpnote_lib::config_value::CfgVal;
use std::str::FromStr;

let cfg_val = CfgVal::from_str(LIB_CONFIG_DEFAULT_TOML).unwrap();

// Run test.
let lib_cfg = LibCfg::try_from(cfg_val).unwrap();

// Check.
assert_eq!(lib_cfg.scheme_sync_default, "default")

Fields

scheme_sync_default: String

The fallback scheme for the sync_filename template choice, if the scheme header variable is empty or is not defined.

scheme: Vec<Scheme>

Configuration of Scheme.

tmpl_html: TmplHtml

Configuration of HTML templates.

Implementations

impl LibCfg

pub fn scheme_idx(&self, name: &str) -> Result<usize, LibCfgError>

Returns the index of a named scheme. If no scheme with that name can be found, return LibCfgError::SchemeNotFound.

pub fn assert_validity(&self) -> Result<(), LibCfgError>

Perform some semantic consistency checks.

• sort_tag.extra_separator must NOT be in sort_tag.extra_chars.
• sort_tag.extra_separator must NOT be in 0..9.
• sort_tag.extra_separator must NOT be in a..z.
• sort_tag.extra_separator must NOT be in sort_tag.extra_chars.
• sort_tag.extra_separator must NOT FILENAME_DOTFILE_MARKER.
• copy_counter.extra_separator must be one of sanitize_filename_reader_friendly::TRIM_LINE_CHARS.
• All characters of sort_tag.separator must be in sort_tag.extra_chars.
• sort_tag.separator must start with NOT FILENAME_DOTFILE_MARKER.

Trait Implementations

impl Debug for LibCfg

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

Formats the value using the given formatter.

impl Default for LibCfg

Reads the file ./config_default.toml (LIB_CONFIG_DEFAULT_TOML) into LibCfg. Panics if this is not possible.

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LibCfg

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for LibCfg

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<CfgVal> for LibCfg

This constructor accepts as input the newtype CfgVal containing a toml::map::Map<String, Value>. Each String is the name of a top level configuration variable. The inner Map is expected to be a data structure that can be copied into the internal temporary variable LibCfgRaw. This internal variable is then processed and the result is stored in a LibCfg struct. For details see the impl TryFrom<LibCfgRaw> for LibCfg. The processing occurs as follows:

1. Merge each incomplete CfgVal(key="scheme") into CfgVal(key="base_scheme") and store the resulting scheme struct in LibCfg.scheme.
2. If CfgVal(key="html_tmpl.viewer_highlighting_css") is empty, generate the value from CfgVal(key="tmpl.viewer_highlighting_theme").
3. Do the same for CfgVal(key="html_tmpl.exporter_highlighting_css").

type Error = LibCfgError

The type returned in the event of a conversion error.

fn try_from(cfg_val: CfgVal) -> Result<Self, Self::Error>

Performs the conversion.