Enum compose_spec::ListOrMap

pub enum ListOrMap {
    List(IndexSet<String>),
    Map(Map),
}

A list of unique strings or a map with optional single values.

Variants

List(IndexSet<String>)

List of unique strings.

Map(Map)

Map with optional single values.

Implementations

impl ListOrMap

pub fn is_empty(&self) -> bool

Returns true if the list or map contain no elements.

pub const fn as_list(&self) -> Option<&IndexSet<String>>

Return Some if a list.

pub const fn as_map(&self) -> Option<&Map>

Return Some if a map.

pub fn into_list(self) -> IndexSet<String>

Convert into a list.

If a map, a new IndexSet is created by joining keys and values with an = character, like so {key}={value}. If the value is None, the key is put into the list as is.

All places ListOrMap is used within Compose support the use of the {key}={value} syntax.

pub fn into_map(self) -> Result<Map, InvalidMapKeyError>

Attempt to convert into a map.

Split list items into keys and values on the ‘=’ character, i.e. {key}={value}. If an item does not contain ‘=’, then the whole item is used as the key and the value is None. If the value is an empty string, then it will also be converted to None.

Alias for self.into_map_split_on(&['=']).

Errors

Returns an error if a key is not a valid MapKey.

pub fn into_map_split_on( self, delimiters: &[char] ) -> Result<Map, InvalidMapKeyError>

Attempt to convert into a map.

Split list items into keys and values with the delimiters. If an item does not contain a delimiter, then the whole item is used as the key and the value is None. If the value is an empty string, then it will also be converted to None.

Errors

Returns an error if a key is not a valid MapKey.

Trait Implementations

impl Clone for ListOrMap

fn clone(&self) -> ListOrMap

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListOrMap

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

Formats the value using the given formatter.

impl Default for ListOrMap

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ListOrMap

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl PartialEq for ListOrMap

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ListOrMap