Struct OwnedItem 

pub struct OwnedItem { /* private fields */ }

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

An Item normally borrows from an Arena. OwnedItem bundles the value with its own allocation so it can be stored, returned, or moved independently of any parse context.

Create one by converting from an Item reference or value, or deserialize directly via FromToml. Access the underlying Item through item().

FromFlattened is not provided because flatten_any is more performant than direct implementation could be. See OwnedTable for an example.

Examples

use toml_spanner::{Arena, OwnedItem, parse};

let arena = Arena::new();
let doc = parse("greeting = 'hello'", &arena).unwrap();
let owned = OwnedItem::from(doc.table()["greeting"].item().unwrap());

drop(arena);
assert_eq!(owned.as_str(), Some("hello"));

Implementations

impl OwnedItem

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

Returns a reference to the contained Item.

The returned item borrows from self and provides the same accessor methods as any other Item (as_str(), as_table(), value(), etc.).

pub fn kind(&self) -> Kind

Returns the type discriminant of this value.

pub fn span(&self) -> Span

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

pub fn as_str(&self) -> Option<&str>

Returns a borrowed string if this is a string value.

pub fn as_i128(&self) -> Option<i128>

Returns an i128 if this is an integer value.

pub fn as_i64(&self) -> Option<i64>

Returns an i64 if this is an integer value that fits in the i64 range.

pub fn as_u64(&self) -> Option<u64>

Returns a u64 if this is an integer value that fits in the u64 range.

pub fn as_f64(&self) -> Option<f64>

Returns an f64 if this is a float or integer value.

Integer values are converted to f64 via as cast (lossy for large values outside the 2^53 exact-integer range).

pub fn as_bool(&self) -> Option<bool>

Returns a bool if this is a boolean value.

pub fn as_array<'a>(&'a self) -> Option<&'a Array<'a>>

Returns a borrowed array if this is an array value.

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

Returns a borrowed table if this is a table value.

pub fn as_datetime(&self) -> Option<&DateTime>

Returns a borrowed DateTime if this is a datetime value.

pub fn value<'a>(&'a self) -> Value<'a, 'a>

Returns a borrowed view for pattern matching.

pub fn has_keys(&self) -> bool

Returns true if the value is a non-empty table.

pub fn has_key(&self, key: &str) -> bool

Returns true if the value is a table containing key.

Trait Implementations

impl Clone for OwnedItem

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 OwnedItem

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

Formats the value using the given formatter.

impl Drop for OwnedItem

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> From<&Item<'a>> for OwnedItem

fn from(item: &Item<'a>) -> Self

Creates an OwnedItem by copying item into a single managed allocation.

All strings (keys and values) are copied, and all table/array backing storage is laid out in one contiguous buffer. The result is fully independent of the source arena.

impl<'a> From<Item<'a>> for OwnedItem

fn from(item: Item<'a>) -> Self

Creates an OwnedItem by copying item into a single managed allocation.

This is a convenience wrapper that delegates to From<&Item>.

impl<'a> FromToml<'a> for OwnedItem

Available on crate feature from-toml only.

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

Attempts to construct Self from a TOML Item.

impl PartialEq for OwnedItem

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 ToFlattened for OwnedItem

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 OwnedItem

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.

impl Send for OwnedItem

impl Sync for OwnedItem