Enum toml_schema::TomlSchema

pub enum TomlSchema {
    Alternative(Vec<TomlSchema>),
    String {
        regex: Regex,
    },
    Integer {
        min: i64,
        max: i64,
    },
    Date,
    Bool,
    Float {
        min: f64,
        max: f64,
        nan_ok: bool,
    },
    Table {
        extras: Vec<TableEntry>,
        min: usize,
        max: usize,
        entries: HashMap<String, (TomlSchema, Option<Value>)>,
    },
    Array {
        cond: Box<TomlSchema>,
        min: usize,
        max: usize,
    },
    Anything,
    Exact(Value),
}

The main type of the crate, it can be constructed from a toml::Table object or by hand, the main constructor for this type is TomlSchema::try_from

Variants

Alternative(Vec<TomlSchema>)

String

Fields

regex: Regex

Integer

Fields

min: i64

max: i64

Date

Bool

Float

Fields

min: f64

max: f64

nan_ok: bool

Table

Fields

extras: Vec<TableEntry>

min: usize

max: usize

entries: HashMap<String, (TomlSchema, Option<Value>)>

Array

Fields

cond: Box<TomlSchema>

min: usize

max: usize

Anything

Exact(Value)

Implementations

impl TomlSchema

pub fn from_table(table: &Table) -> Result<(TomlSchema, Option<Value>), String>

The internal constructor for a schema, from toml data, the returned values are

• Ok(..) => the schema and it’s default value
• Err(..) => Some kind of indication on where parsing the schema falied

note: no checking is done on the default values, that means the schema may contain default values that dont match it and fail on valid data using check_and_complete(..)

impl TomlSchema

pub fn check<'s, 'v>( &'s self, data: &'v Value ) -> Result<(), SchemaError<'s, 'v>>

This checks that a toml value matches a schema, without modifying/copying, the returned error cannot outlive the passed toml value or self since it contains references to them

pub fn check_and_complete<'s, 'v>( &'s self, data: &'v mut Value ) -> Result<(), SchemaError<'s, 'v>>

Check that the data matches the schema and fills in the default values as needed

important note: default values are checked against the schema and validation will fail if a default value does not match the schema, this means that TomlSchema::check_and_complete can fail even when TomlSchema::check passes

Trait Implementations

impl Clone for TomlSchema

fn clone(&self) -> TomlSchema

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TomlSchema

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

Formats the value using the given formatter.

impl From<&TomlSchema> for SchemaType

fn from(value: &TomlSchema) -> Self

Converts to this type from the input type.

impl TryFrom<Map<String, Value>> for TomlSchema

fn try_from(table: Table) -> Result<Self, String>

The main constructor for a TomlSchema, calls TomlSchema::from_table and discards the default value

note: default values are not checked against the schema

type Error = String

The type returned in the event of a conversion error.