Struct valid_toml::TomlData

pub struct TomlData {
    pub warnings: LinkedList<Warning>,
    // some fields omitted
}

Contains the verified results from a TOML file. Only the data elements defined are stored from the TOML file. This object is not created unless the TOML data matches the definition so it is safe to assume required values are present and valid.

Fields

warnings: LinkedList<Warning>

The list of warnings that were generated when reading in the TOML file.

Methods

impl TomlData

fn new(
    data: BTreeMap<String, ItemValue>,
    warnings: LinkedList<Warning>
) -> TomlData

Construct a new instance of the object.

fn optional_duration<T: AsRef<str>>(&self, name: T) -> Option<i64>

Returns a duration (in milliseconds) from the TOML file. If the value is optional and not defined then None is returned.

Panics

If the value is defined but not a duration this method will panic since that indicates a disconnect between the definition and the code reading the values.

fn optional_i64<T: AsRef<str>>(&self, name: T) -> Option<i64>

Returns an i64 value from the TOML file. If the value is optional and not defined then None is returned.

Panics

If the value is defined but not an i64 value this method will panic since that indicates a disconnect between the definition and the code reading the values.

fn optional_u16<T: AsRef<str>>(&self, name: T) -> Option<u16>

Returns an u16 value from the TOML file. If the value is optional and not defined then None is returned.

Panics

If the value is defined but not an u16 value this method will panic since that indicates a disconnect between the definition and the code reading the values.

fn optional_usize<T: AsRef<str>>(&self, name: T) -> Option<usize>

Returns an usize value from the TOML file. If the value is optional and not defined then None is returned.

Panics

If the value is defined but not an usize value this method will panic since that indicates a disconnect between the definition and the code reading the values.

fn optional_str<'a, T: AsRef<str>>(&'a self, name: T) -> Option<&'a str>

Returns an string value from the TOML file. If the value is optional and not defined then None is returned.

Panics

If the value is defined but not a string value this method will panic since that indicates a disconnect between the definition and the code reading the values.

fn get_duration<T: AsRef<str>>(&self, name: T) -> i64

Returns a required duration.

Panics

If the value is defined but not a duration this method will panic since that indicates a disconnect between the definition and the code reading the values.

If the value doesn't exist then this method will panic since that means the value is not actually required.

fn get_i64<T: AsRef<str>>(&self, name: T) -> i64

Returns a required i64 value.

Panics

If the value is defined but not an i64 value this method will panic since that indicates a disconnect between the definition and the code reading the values.

If the value doesn't exist then this method will panic since that means the value is not actually required.

fn get_u16<T: AsRef<str>>(&self, name: T) -> u16

Returns a required u16 value.

Panics

If the value is defined but not an u16 value this method will panic since that indicates a disconnect between the definition and the code reading the values.

If the value doesn't exist then this method will panic since that means the value is not actually required.

fn get_usize<T: AsRef<str>>(&self, name: T) -> usize

Returns a required usize value.

Panics

If the value is defined but not an usize value this method will panic since that indicates a disconnect between the definition and the code reading the values.

If the value doesn't exist then this method will panic since that means the value is not actually required.

fn get_str<'a, T: AsRef<str>>(&'a self, name: T) -> &'a str

Returns a required string value.

Panics

If the value is defined but not a string value this method will panic since that indicates a disconnect between the definition and the code reading the values.

If the value doesn't exist then this method will panic since that means the value is not actually required.