Struct Ion 

pub struct Ion { /* private fields */ }

Parsed Ion document.

The document is a map of section names to Section values. The concrete backing map is Sections, so iteration order follows the selected backend:

• default: sorted by section name
• dictionary-indexmap: insertion order

Implementations

impl Ion

pub fn new(sections: Sections) -> Ion

Builds a document from an existing section map.

pub fn from_str_filtered( s: &str, accepted_sections: Vec<&str>, ) -> Result<Self, IonError>

Errors

Returns a parser error when the input cannot be parsed into a valid Ion document.

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

Returns the section with the provided name.

pub fn get_mut(&mut self, key: &str) -> Option<&mut Section>

Returns a mutable reference to the section associated with the given key.

If a section exists for the provided key, a mutable reference to that section is returned. If no section is associated with the key, None is returned.

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

Retrieves a key-value pair from the sections.

This method attempts to find a section by its key within the collection of sections. If the section exists, it returns an Option containing a tuple of the key as a reference to a string slice and the value as a reference to a Section. If the key does not exist within the sections, it returns None.

Returns

Returns Option<(&str, &Section)>. If the key is found, the return value is Some((&str, &Section)), where the first element is a reference to the key and the second element is a reference to the corresponding Section. If the key is not found, it returns None.

pub fn fetch(&self, key: &str) -> Result<&Section, IonError>

Errors

Returns IonError::MissingSection when the key does not exist.

pub fn remove(&mut self, key: &str) -> Option<Section>

Removes and returns a section.

In dictionary-indexmap builds this preserves the order of the remaining sections.

pub fn iter(&self) -> impl Iterator<Item = (&str, &Section)>

Iterates over section name / section pairs.

Trait Implementations

impl Clone for Ion

fn clone(&self) -> Ion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Ion

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

Formats the value using the given formatter.

impl Display for Ion

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

Formats the value using the given formatter.

impl FromStr for Ion

type Err = IonError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Ion, IonError>

Parses a string s to return a value of this type.