Type Alias Document

pub type Document = DocumentMut;

👎Deprecated since 0.22.6: Replaced with DocumentMut

Deprecated, replaced with DocumentMut

Aliased Type

struct Document { /* private fields */ }

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 200 bytes

Implementations

impl DocumentMut

pub fn new() -> Self

Creates an empty document

pub fn as_item(&self) -> &Item

Returns a reference to the root item.

pub fn as_item_mut(&mut self) -> &mut Item

Returns a mutable reference to the root item.

pub fn as_table(&self) -> &Table

Returns a reference to the root table.

pub fn as_table_mut(&mut self) -> &mut Table

Returns a mutable reference to the root table.

pub fn iter(&self) -> Iter<'_>

Returns an iterator over the root table.

pub fn set_trailing(&mut self, trailing: impl Into<RawString>)

Set whitespace after last element

pub fn trailing(&self) -> &RawString

Whitespace after last element

Trait Implementations

impl Clone for DocumentMut

fn clone(&self) -> DocumentMut

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentMut

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

Formats the value using the given formatter.

impl Default for DocumentMut

fn default() -> Self

Returns the “default value” for a type.

impl Deref for DocumentMut

type Target = Table

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for DocumentMut

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Display for DocumentMut

Available on crate feature display only.

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

Formats the value using the given formatter.

impl From<Table> for DocumentMut

fn from(root: Table) -> Self

Converts to this type from the input type.

impl FromStr for DocumentMut

Available on crate feature parse only.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a document from a &str

type Err = TomlError

The associated error which can be returned from parsing.

impl<'s> Index<&'s str> for DocumentMut

type Output = Item

The returned type after indexing.

fn index(&self, key: &'s str) -> &Item

Performs the indexing (container[index]) operation.

impl<'s> IndexMut<&'s str> for DocumentMut

fn index_mut(&mut self, key: &'s str) -> &mut Item

Performs the mutable indexing (container[index]) operation.

impl IntoDeserializer<'_, Error> for DocumentMut

Available on crate feature serde only.

type Deserializer = Deserializer

The type of the deserializer being converted into.

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.