Struct Shape 

pub struct Shape { /* private fields */ }

The shape of one table of a document: which keys it holds, which tables sit inside it and which of its keys carry an array of tables.

A Document is read against the shape of its root table. Keys are single names, never dotted paths: nesting is declared with Shape::table, which reads both [mounts] with project under it and the same key written as mounts.project.

use qframe::document::{Document, Shape, ValueKind};

let profile = Shape::new().required("name", ValueKind::text()).optional("added", ValueKind::text());
let shape = Shape::new()
    .required("id", ValueKind::text())
    .optional("created", ValueKind::text())
    .table("mounts", Shape::new().optional("assets", ValueKind::choice(["rw", "ro"])))
    .entries("profile", profile);

let text = "id = \"api\"\n\n[mounts]\nassets = \"ro\"\n\n[[profile]]\nname = \"review\"\n";
let document = Document::parse("project.qcode", text, &shape);
assert!(document.is_clean());
assert_eq!(document.root().text("id"), Some("api"));
assert_eq!(document.root().table("mounts").and_then(|mounts| mounts.text("assets")), Some("ro"));
assert_eq!(document.root().entries("profile").len(), 1);

Implementations

impl Shape

pub fn new() -> Self

A table that holds nothing yet. Every key it may hold is declared on it.

pub fn required(self, key: &str, kind: ValueKind) -> Self

A key the document must hold: a document without it, or with a value of another type, is reported as an error. Declaring a name again replaces what it declared before.

pub fn optional(self, key: &str, kind: ValueKind) -> Self

A key the document may hold: it is read when it is there and of the declared type, a value of another type is a warning, and a missing key is not a problem at all.

pub fn table(self, key: &str, shape: Shape) -> Self

A table inside this one, [key] with shape below it.

The table itself is optional: a document without it is not a problem, and the keys of a missing table read as missing. Its required keys are required once the table is there.

pub fn entries(self, key: &str, shape: Shape) -> Self

An array of tables, [[key]] repeated, each entry shaped by shape.

The array itself is optional: a document that lists no entry simply has none. Each entry is checked on its own, and an entry that is missing a required key is reported where it starts, beside the entries that were read.

Trait Implementations

impl Clone for Shape

fn clone(&self) -> Shape

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Shape

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

Formats the value using the given formatter.

impl Default for Shape

fn default() -> Shape

Returns the “default value” for a type.

impl Eq for Shape

impl PartialEq for Shape

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Shape