Struct ParameterCollection 

pub struct ParameterCollection { /* private fields */ }

Collection of key-value parameters.

Preserves insertion order and supports nested parameter strings.

Implementations

impl ParameterCollection

pub fn new() -> Self

Creates an empty parameter collection.

pub fn from_string(data: &str) -> Self

Creates a parameter collection from a string.

pub fn from_string_with_level(data: &str, level: usize) -> Self

Creates a parameter collection from a string at a specific nesting level.

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

Returns true if the collection contains the given key.

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

Gets a parameter value by key.

pub fn get_or(&self, key: &str, default: &str) -> ParameterValue

Gets a parameter value by key, or returns a default value.

pub fn get_at(&self, index: usize) -> Option<(&str, ParameterValue)>

Gets the value at the given index.

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

Returns the index of a key, or None if not found.

pub fn add(&mut self, key: &str, value: &str)

Adds a string value.

pub fn add_int(&mut self, key: &str, value: i32)

Adds an integer value.

pub fn add_double(&mut self, key: &str, value: f64, decimals: usize)

Adds a double value with specified decimal places.

pub fn add_bool(&mut self, key: &str, value: bool)

Adds a boolean value.

pub fn add_coord(&mut self, key: &str, value: Coord)

Adds a coordinate value as mils.

pub fn add_color(&mut self, key: &str, value: Color)

Adds a color value.

pub fn remove(&mut self, key: &str)

Removes a parameter by key.

pub fn len(&self) -> usize

Returns the number of parameters.

pub fn is_empty(&self) -> bool

Returns true if empty.

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

Returns an iterator over (key, value) pairs.

pub fn level(&self) -> usize

Returns the nesting level.

pub fn set_use_long_booleans(&mut self, value: bool)

Sets whether to use long boolean format.

pub fn to_param_string(&self) -> String

Converts the collection back to a parameter string.

Trait Implementations

impl Clone for ParameterCollection

fn clone(&self) -> ParameterCollection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParameterCollection

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

Formats the value using the given formatter.

impl Default for ParameterCollection

fn default() -> ParameterCollection

Returns the “default value” for a type.

impl Display for ParameterCollection

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

Formats the value using the given formatter.

impl FromBinary for ParameterCollection

fn read_from<R: Read>(reader: &mut R) -> Result<Self>

Read this type from a binary stream.

fn read_from_preserving<R: Read>( reader: &mut R, _block_size: usize, ) -> Result<(Self, Vec<u8>)>

Read this type and preserve remaining bytes for non-destructive editing.

impl<'a> IntoIterator for &'a ParameterCollection

type Item = (&'a str, ParameterValue)

The type of the elements being iterated over.

type IntoIter = Box<dyn Iterator<Item = (&'a str, ParameterValue)> + 'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl ToBinary for ParameterCollection

fn write_to<W: Write>(&self, writer: &mut W) -> Result<()>

Write this type to a binary stream.

fn binary_size(&self) -> usize

Calculate the binary size of this type.