Struct valid_toml::ItemU16

pub struct ItemU16 { /* fields omitted */ }

This item is used to read an 16 bit unsigned number from the TOML file.

Methods

impl ItemU16

fn with_name<T: AsRef<str>>(name: T) -> ItemU16

Constructs a new instance of the ItemU16 object.

fn add_to(self, group: &mut TomlDef) -> U16Value

Adds the item to a group and returns an option that will receive the item's value when the file is loaded. Basically this allows a program to receive a value laoded from the file without getting the TomlData object that was created.

Examples

use valid_toml::{TomlDef, ItemStr, ItemU16};

let file = r#"
    password = "secret"
    count   = 15
    "#;

let mut def = TomlDef::new();

let password = ItemStr::with_name("password").min(3).max(8).add_to(&mut def);
let count    = ItemU16::with_name("count").optional().add_to(&mut def);

let file = def.parse_toml(file).unwrap();

assert_eq!(password.get(), "secret");
assert_eq!(count.get(), 15);

fn min(self, min: u16) -> Self

Defines the minimum value (inclusive) of the value read from the file.

Panics

This method will panic if max is set and is less than min.

fn max(self, max: u16) -> Self

Defines the maximum value (inclusive) of the value read from the file.

Panics

This method will panic if min is set and is greater than max.

fn optional(self) -> Self

Marks the item as optional without providing a default value.

fn default(self, default: u16) -> Self

Defines the default value for the item. This method makes the item optional. The default value will only be used if the parent group exists.