Struct Document 

pub struct Document<'de> {
    pub ctx: Context<'de>,
    /* private fields */
}

The result of parsing a TOML document.

Wraps the parsed Table tree and a Context that accumulates errors.

Access values via index operators (doc["key"]) which return MaybeItem, or use table_helper and to for typed conversion.

Examples

let arena = toml_spanner::Arena::new();
let doc = toml_spanner::parse("name = 'world'", &arena).unwrap();
assert_eq!(doc["name"].as_str(), Some("world"));

Fields

ctx: Context<'de>

Available on crate feature from-toml only.

Implementations

impl<'de> Document<'de>

pub fn into_table(self) -> Table<'de>

Consumes the document and returns the underlying Table.

pub fn into_item(self) -> Item<'de>

Converts the root table into an Item with the same span and payload.

pub fn table(&self) -> &Table<'de>

Returns a shared reference to the root table.

pub fn split(&mut self) -> (&mut Context<'de>, &Table<'de>)

Available on crate feature from-toml only.

Returns disjoint borrows of the Context and the root Table.

Useful when passing the context into TableHelper::new while still holding a reference to the table.

impl<'de> Document<'de>

pub fn table_helper<'ctx>(&'ctx mut self) -> TableHelper<'ctx, 'ctx, 'de>

Available on crate feature from-toml only.

Creates a TableHelper for the root table.

Typical entry point for typed extraction. Extract fields with TableHelper::required and TableHelper::optional, then call TableHelper::require_empty to reject unknown keys.

pub fn to<T: FromToml<'de>>(&mut self) -> Result<T, FromTomlError>

Available on crate feature from-toml only.

Converts the root table into a typed value T via FromToml.

Errors

Returns FromTomlError containing all accumulated errors.

pub fn to_allowing_errors<T>( &mut self, ) -> Result<(T, FromTomlError), FromTomlError>

where T: FromToml<'de>,

Available on crate feature from-toml only.

Converts the root table into a typed value T via FromToml. returning non-fatal errors alongside.

Errors

Returns FromTomlError containing all accumulated errors.

pub fn errors(&self) -> &[Error]

Available on crate feature from-toml only.

Returns the accumulated errors.

pub fn has_errors(&self) -> bool

Available on crate feature from-toml only.

Returns true if any errors have been recorded.

Trait Implementations

impl Debug for Document<'_>

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

Formats the value using the given formatter.

impl<'de> Index<&str> for Document<'de>

type Output = MaybeItem<'de>

The returned type after indexing.

fn index(&self, key: &str) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Serialize for Document<'_>

Available on crate feature serde only.

fn serialize<S>(&self, ser: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.