Struct OwnedTable 

pub struct OwnedTable { /* private fields */ }

A self-contained TOML table that owns its backing storage.

The table-specific counterpart of OwnedItem. The inner value is always a table, so table() is infallible.

Flattening

FromFlattened is not provided because flatten_any is more performant than direct implementation could be, due to current trait definition.

use toml_spanner::Toml;
use toml_spanner::helper::flatten_any;

#[derive(Toml)]
#[toml(Toml)]
struct Config {
    name: String,
    #[toml(flatten, with = flatten_any)]
    extra: OwnedTable,
}

Examples

use toml_spanner::OwnedTable;

let owned: OwnedTable = toml_spanner::from_str("
host = 'localhost'
port = 8080
").unwrap();

assert_eq!(owned.get("host").unwrap().as_str(), Some("localhost"));
assert_eq!(owned.len(), 2);

Implementations

impl OwnedTable

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

Returns a reference to the contained Table.

pub fn span(&self) -> Span

Returns the source span, or 0..0 if this table was constructed programmatically (format-hints mode).

pub fn len(&self) -> usize

Returns the number of entries.

pub fn is_empty(&self) -> bool

Returns true if the table has no entries.

pub fn get_key_value<'a>( &'a self, name: &str, ) -> Option<(&'a Key<'a>, &'a Item<'a>)>

Returns references to both key and value for name.

pub fn get<'a>(&'a self, name: &str) -> Option<&'a Item<'a>>

Returns a reference to the value for name.

pub fn contains_key(&self, name: &str) -> bool

Returns true if the table contains the key.

pub fn entries<'a>(&'a self) -> &'a [(Key<'a>, Item<'a>)]

Returns a slice of all entries.

pub fn iter<'a>(&'a self) -> Iter<'a, (Key<'a>, Item<'a>)>

Returns an iterator over all entries (key-value pairs).

pub fn as_item<'a>(&'a self) -> &'a Item<'a>

Returns the contained table as an Item reference.

pub fn style(&self) -> TableStyle

Returns the kind of this table (implicit, dotted, header, or inline).

Trait Implementations

impl Clone for OwnedTable

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OwnedTable

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

Formats the value using the given formatter.

impl From<&Table<'_>> for OwnedTable

fn from(value: &Table<'_>) -> Self

Converts to this type from the input type.

impl<'a> FromToml<'a> for OwnedTable

Available on crate feature from-toml only.

fn from_toml(ctx: &mut Context<'a>, item: &Item<'a>) -> Result<Self, Failed>

Attempts to construct Self from a TOML Item.

impl<'a> IntoIterator for &'a OwnedTable

type Item = &'a (Key<'a>, Item<'a>)

The type of the elements being iterated over.

type IntoIter = Iter<'a, (Key<'a>, Item<'a>)>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for OwnedTable

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Send for OwnedTable

impl Sync for OwnedTable

impl ToFlattened for OwnedTable

Available on crate feature to-toml only.

fn to_flattened<'a>( &'a self, arena: &'a Arena, table: &mut Table<'a>, ) -> Result<(), ToTomlError>

Inserts this value’s entries directly into an existing table.

impl ToToml for OwnedTable

Available on crate feature to-toml only.

fn to_toml<'a>(&'a self, arena: &'a Arena) -> Result<Item<'a>, ToTomlError>

Produces a TOML Item representing this value.

fn to_optional_toml<'a>( &'a self, arena: &'a Arena, ) -> Result<Option<Item<'a>>, ToTomlError>

Produces an optional TOML Item representing this value.