Struct Section

pub struct Section { /* private fields */ }

A section containing key-value pairs and nested subsections.

Sections form a hierarchical structure similar to directories, where each section can contain both values and other sections.

Implementations

impl Section

pub fn new() -> Self

Create a new empty section.

pub fn get_or_create_value(&mut self, key: &str) -> &mut Value

Get a value by key, creating it if it doesn’t exist.

This is similar to the C++ operator[] behavior.

pub fn at(&self, key: &str) -> Result<&Value>

Get a value by key.

pub fn get_value(&self, key: &str) -> Result<&Value>

Get a value by key.

pub fn get_value_mut(&mut self, key: &str) -> Result<&mut Value>

Get a mutable value by key.

pub fn set_value(&mut self, key: impl Into<String>, value: impl Into<Value>)

Set a value for a key.

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

Check if a value exists for the given key.

pub fn remove_value(&mut self, key: &str) -> Option<Value>

Remove a value by key.

pub fn get_section(&self, name: &str) -> Result<&Section>

Get a subsection by name.

pub fn section(&mut self, name: &str) -> &mut Section

Get a subsection by name, creating it if it doesn’t exist.

pub fn get_section_mut(&mut self, name: &str) -> Result<&mut Section>

Get a mutable subsection by name.

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

Check if a subsection exists.

pub fn remove_section(&mut self, name: &str) -> Option<Section>

Remove a subsection by name.

pub fn values(&self) -> impl Iterator<Item = (&String, &Value)>

Iterate over all values in this section.

pub fn values_mut(&mut self) -> impl Iterator<Item = (&String, &mut Value)>

Iterate over all values in this section (mutable).

pub fn sections(&self) -> impl Iterator<Item = (&String, &Section)>

Iterate over all subsections in this section.

pub fn sections_mut(&mut self) -> impl Iterator<Item = (&String, &mut Section)>

Iterate over all subsections in this section (mutable).

pub fn clear(&mut self)

Clear all values and subsections.

pub fn is_empty(&self) -> bool

Check if this section is empty (no values and no subsections).

pub fn value_count(&self) -> usize

Get the number of values in this section.

pub fn section_count(&self) -> usize

Get the number of subsections in this section.

pub fn value_keys(&self) -> impl Iterator<Item = &String>

Get all value keys.

pub fn section_names(&self) -> impl Iterator<Item = &String>

Get all section names.

Trait Implementations

impl Clone for Section

fn clone(&self) -> Section

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Section

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

Formats the value using the given formatter.

impl Default for Section

fn default() -> Section

Returns the “default value” for a type.

impl Index<&str> for Section

type Output = Value

The returned type after indexing.

fn index(&self, key: &str) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<&str> for Section

fn index_mut(&mut self, key: &str) -> &mut Self::Output

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

impl PartialEq for Section

fn eq(&self, other: &Section) -> 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 StructuralPartialEq for Section