Struct CfgVal

pub struct CfgVal(/* private fields */);

A newtype holding configuration data.

Implementations

impl CfgVal

This API deals with configuration values.

pub fn new() -> Self

Constructor returning an empty map.

pub fn extend(&mut self, other: Self)

Append key, value pairs from other to self.

use tpnote_lib::config_value::CfgVal;
use std::str::FromStr;

let toml1 = "\
[arg_default]
scheme = 'zettel'
";

let toml2 = "\
[base_scheme]
name = 'some name'
";

let mut cfg1 = CfgVal::from_str(toml1).unwrap();
let cfg2 = CfgVal::from_str(toml2).unwrap();

let expected = CfgVal::from_str("\
[arg_default]
scheme = 'zettel'
[base_scheme]
name = 'some name'
").unwrap();

// Run test
cfg1.extend(cfg2);

assert_eq!(cfg1, expected);

pub fn insert(&mut self, key: String, val: Value)

pub fn merge(self, other: Self) -> Self

Merges configuration values from other into self and returns the result. The top level element is a set of key and value pairs (map). If one of its values is a Value::Array, then the corresponding array from other is appended. Otherwise the corresponding other value replaces the self value. Deeper nested Value::Arrays are never appended but always replaced (CONFIG_FILE_MERGE_PEPTH=2). Append key, value pairs from other to self.

use tpnote_lib::config_value::CfgVal;
use std::str::FromStr;

let toml1 = "\
version = '1.0.0'
[[scheme]]
name = 'default'
";
let toml2 = "\
version = '2.0.0'
[[scheme]]
name = 'zettel'
";

let mut cfg1 = CfgVal::from_str(toml1).unwrap();
let cfg2 = CfgVal::from_str(toml2).unwrap();

let expected = CfgVal::from_str("\
version = '2.0.0'
[[scheme]]
name = 'default'
[[scheme]]
name = 'zettel'
").unwrap();

// Run test
let res = cfg1.merge(cfg2);

assert_eq!(res, expected);

pub fn to_value(self) -> Value

Convert to toml::Value.

use tpnote_lib::config_value::CfgVal;
use std::str::FromStr;

let toml1 = "\
version = 1
[[scheme]]
name = 'default'
";

let cfg1 = CfgVal::from_str(toml1).unwrap();

let expected: toml::Value = toml::from_str(toml1).unwrap();

// Run test
let res = cfg1.to_value();

assert_eq!(res, expected);

Trait Implementations

impl Clone for CfgVal

fn clone(&self) -> CfgVal

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CfgVal

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

Formats the value using the given formatter.

impl Default for CfgVal

fn default() -> CfgVal

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CfgVal

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CfgVal> for Value

fn from(cfg_val: CfgVal) -> Self

Converts to this type from the input type.

impl FromStr for CfgVal

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

Constructor taking a text to deserialize. Throws an error if the deserialized root element is not a Value::Table.

type Err = LibCfgError

The associated error which can be returned from parsing.

impl PartialEq for CfgVal

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CfgVal

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.

impl StructuralPartialEq for CfgVal