Struct Document 

pub struct Document { /* private fields */ }

A document read against a Shape: the part that could be read, and a diagnostic for everything that could not.

Reading never writes, never repairs and never panics. See the module documentation for what each kind of problem becomes.

Implementations

impl Document

pub fn parse(file: &str, text: &str, shape: &Shape) -> Self

Reads TOML text as the document shape describes, reporting problems against file.

pub fn open(path: impl AsRef<Path>, shape: &Shape) -> Result<Self>

Reads the document at path, reporting problems against the file’s name.

Errors

Returns the I/O error when the file cannot be read. A file that is not there is one of those errors, not an empty document: a data file the application has not written yet and one it wrote empty mean different things, and only the application knows which it expects.

pub fn root(&self) -> &Table

The document’s root table.

pub fn diagnostics(&self) -> &[Diagnostic]

Every problem found while reading, in the order they were found.

pub fn is_clean(&self) -> bool

Whether nothing at all was wrong with the document.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.

impl Eq for Document

impl PartialEq for Document

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Document