Struct toml_edit::ImDocument

source ·
pub struct ImDocument<S> { /* private fields */ }
Expand description

Type representing a parsed TOML document

Implementations§

source§

impl ImDocument<&'static str>

source

pub fn new() -> Self

Creates an empty document

source§

impl<S: AsRef<str>> ImDocument<S>

source

pub fn parse(raw: S) -> Result<Self, TomlError>

Parse a TOML document

source§

impl<S> ImDocument<S>

source

pub fn as_item(&self) -> &Item

Returns a reference to the root item.

source

pub fn as_table(&self) -> &Table

Returns a reference to the root table.

source

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

Returns an iterator over the root table.

source

pub fn trailing(&self) -> &RawString

Whitespace after last element

source§

impl<S: AsRef<str>> ImDocument<S>

source

pub fn raw(&self) -> &str

Access the raw, unparsed document

source§

impl<S: AsRef<str>> ImDocument<S>

source

pub fn into_mut(self) -> DocumentMut

Allow editing of the DocumentMut

Methods from Deref<Target = Table>§

source

pub fn get_values(&self) -> Vec<(Vec<&Key>, &Value)>

Get key/values for values that are visually children of this table

For example, this will return dotted keys

source

pub fn is_implicit(&self) -> bool

If a table has no key/value pairs and implicit, it will not be displayed.

source

pub fn is_dotted(&self) -> bool

Check if this is a wrapper for dotted keys, rather than a standard table

source

pub fn position(&self) -> Option<usize>

The position of the Table within the DocumentMut.

Returns None if the Table was created manually (i.e. not via parsing) in which case its position is set automatically. This can be overridden with Table::set_position.

source

pub fn decor(&self) -> &Decor

Returns the decor associated with a given key of the table.

source

pub fn key(&self, key: &str) -> Option<&Key>

Returns an accessor to a key’s formatting

source

pub fn key_decor(&self, key: &str) -> Option<&Decor>

👎Deprecated since 0.21.1: Replaced with key_mut

Returns the decor associated with a given key of the table.

source

pub fn span(&self) -> Option<Range<usize>>

The location within the original document

This generally requires an ImDocument.

source

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

Returns an iterator over all key/value pairs, including empty.

source

pub fn len(&self) -> usize

Returns the number of non-empty items in the table.

source

pub fn is_empty(&self) -> bool

Returns true if the table is empty.

source

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

Returns an optional reference to an item given the key.

source

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

Return references to the key-value pair stored for key, if it is present, else None.

source

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

Returns true if the table contains an item with the given key.

source

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

Returns true if the table contains a table with the given key.

source

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

Returns true if the table contains a value with the given key.

source

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

Returns true if the table contains an array of tables with the given key.

Trait Implementations§

source§

impl<S: Clone> Clone for ImDocument<S>

source§

fn clone(&self) -> ImDocument<S>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<S: Debug> Debug for ImDocument<S>

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for ImDocument<&'static str>

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl<S> Deref for ImDocument<S>

§

type Target = Table

The resulting type after dereferencing.
source§

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

Dereferences the value.
source§

impl<S> From<ImDocument<S>> for Deserializer<S>

source§

fn from(doc: ImDocument<S>) -> Self

Converts to this type from the input type.
source§

impl FromStr for ImDocument<String>

source§

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.
source§

impl<'de> IntoDeserializer<'de, Error> for ImDocument<String>

§

type Deserializer = Deserializer

The type of the deserializer being converted into.
source§

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

Auto Trait Implementations§

§

impl<S> Freeze for ImDocument<S>
where S: Freeze,

§

impl<S> RefUnwindSafe for ImDocument<S>
where S: RefUnwindSafe,

§

impl<S> Send for ImDocument<S>
where S: Send,

§

impl<S> Sync for ImDocument<S>
where S: Sync,

§

impl<S> Unpin for ImDocument<S>
where S: Unpin,

§

impl<S> UnwindSafe for ImDocument<S>
where S: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.