Struct roead::aamp::ParameterObject

pub struct ParameterObject(pub IndexMap<Name, Parameter, BuildHasherDefault<FxHasher>>);

Parameter object. This is essentially a dictionary of parameters.

Tuple Fields

0: IndexMap<Name, Parameter, BuildHasherDefault<FxHasher>>

Implementations

impl ParameterObject

pub fn len(&self) -> usize

Return the number of entries.

pub fn is_empty(&self) -> bool

Returns true if the map is empty.

pub fn insert<N: Into<Name>>(&mut self, key: N, value: Parameter)

Insert a new entry.

pub fn extend<I: IntoIterator<Item = (Name, Parameter)>>(&mut self, iter: I)

Insert multiple entries from an iterator.

pub fn get<N: Into<Name>>(&self, key: N) -> Option<&Parameter>

Get an entry value by name or hash.

pub fn get_mut<N: Into<Name>>(&mut self, key: N) -> Option<&mut Parameter>

Get an entry value mutably by name or hash.

pub fn entry<N: Into<Name>>(&mut self, key: N) -> Entry<'_, Name, Parameter>

Get a full entry by name or hash.

pub fn iter(&self) -> impl Iterator<Item = (&Name, &Parameter)>

Iterate entries.

pub fn iter_mut(&mut self) -> impl Iterator<Item = (&Name, &mut Parameter)>

Iterate entries mutably.

pub fn iter_by_name( &self ) -> impl Iterator<Item = (Result<&'static Cow<'static, str>, u32>, &Parameter)>

Iterate entries by name (this is potentially rather expensive, as the name for each hash must be looked up from the default name table). It returns a Result for each name, with the found name as the success value or the hash as the error value.

This is only available with the yaml feature.

impl ParameterObject

pub fn new() -> Self

Create a new empty parameter object.

pub fn with_parameter<N: Into<Name>>( self, name: N, parameter: Parameter ) -> ParameterObject

Builder-like method to add a new parameter.

pub fn with_parameters<N: Into<Name>, I: IntoIterator<Item = (N, Parameter)>>( self, iter: I ) -> ParameterObject

Builder-like method to add multiple parameters from an iterator.

Trait Implementations

impl Clone for ParameterObject

fn clone(&self) -> ParameterObject

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ParameterObject

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

Formats the value using the given formatter.

impl Default for ParameterObject

fn default() -> ParameterObject

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ParameterObject

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<N: Into<Name>> FromIterator<(N, Parameter)> for ParameterObject

fn from_iter<T: IntoIterator<Item = (N, Parameter)>>(iter: T) -> Self

Creates a value from an iterator.

impl<N: Into<Name>> Index<N> for ParameterObject

type Output = Parameter

The returned type after indexing.

fn index(&self, name: N) -> &Parameter

Performs the indexing (container[index]) operation.

impl<N: Into<Name>> IndexMut<N> for ParameterObject

fn index_mut(&mut self, name: N) -> &mut Parameter

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

impl PartialEq for ParameterObject

fn eq(&self, other: &ParameterObject) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ParameterObject

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ParameterObject

impl StructuralPartialEq for ParameterObject