Struct valid_toml::ItemStr
[−]
[src]
pub struct ItemStr { /* fields omitted */ }
This item is used to read an string value from the TOML file
Methods
impl ItemStr
[src]
fn with_name<T: AsRef<str>>(name: T) -> ItemStr
Constructs a new instance of the ItemUsize object.
fn add_to(self, group: &mut TomlDef) -> StringValue
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, ItemUsize}; 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 = ItemUsize::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: usize) -> Self
Defines the minimum length the string can be.
fn max(self, max: usize) -> Self
Defines the maximum length the string can be.
fn optional(self) -> Self
Marks the item as optional without providing a default value.
fn default<T: AsRef<str>>(self, default: T) -> 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.