Struct Properties

pub struct Properties { /* private fields */ }

Map of property names to property values.

It features O(log n) lookup and preserves insertion order, as well as convenience methods for type-safe access and parsing of values.

This structure is case-sensitive. It’s the caller’s responsibility to ensure all keys and values are lowercased.

Implementations

impl Properties

pub const fn new() -> Properties

Constructs a new empty Properties.

pub fn len(&self) -> usize

Returns the number of key-value pairs, including those with empty values.

pub fn is_empty(&self) -> bool

Returns true if self contains no key-value pairs.

pub fn get_raw_for_key(&self, key: impl AsRef<str>) -> &RawValue

Returns the unparsed “raw” value for the specified key.

Does not test for the “unset” value. Use RawValue::filter_unset.

pub fn get_raw<T: PropertyKey>(&self) -> &RawValue

Returns the unparsed “raw” value for the specified property.

Does not test for the “unset” value. Use RawValue::filter_unset.

pub fn get<T: PropertyKey + PropertyValue>(&self) -> Result<T, &RawValue>

Returns the parsed value for the specified property.

Does not test for the “unset” value if parsing fails. Use RawValue::filter_unset.

pub fn iter(&self) -> Iter<'_>

Returns an iterator over the key-value pairs.

If the allow-empty-values feature is NOT used, key-value pairs where the value is empty will be skipped. Otherwise, they will be returned as normal.

Pairs are returned from oldest to newest.

pub fn iter_mut(&mut self) -> IterMut<'_>

Returns an iterator over the key-value pairs that allows mutation of the values.

If the allow-empty-values feature is NOT used, key-value pairs where the value is empty will be skipped. Otherwise, they will be returned as normal.

Pairs are returned from oldest to newest.

pub fn insert_raw_for_key( &mut self, key: impl AsRef<str>, val: impl Into<RawValue>, )

Sets the value for a specified key.

pub fn insert_raw<K: PropertyKey, V: Into<RawValue>>(&mut self, val: V)

Sets the value for a specified property’s key.

pub fn insert<T: PropertyKey + Into<RawValue>>(&mut self, prop: T)

Inserts a specified property into the map.

pub fn try_insert_raw_for_key( &mut self, key: impl AsRef<str>, value: impl Into<RawValue>, ) -> Result<(), &mut RawValue>

Attempts to add a new key-value pair to the map.

If the key was already associated with a value, returns a mutable reference to the old value and does not update the map.

pub fn try_insert_raw<K: PropertyKey, V: Into<RawValue>>( &mut self, val: V, ) -> Result<(), &mut RawValue>

Attempts to add a new property to the map with a specified value.

If the key was already associated with a value, returns a mutable reference to the old value and does not update the map.

pub fn try_insert<T: PropertyKey + Into<RawValue>>( &mut self, prop: T, ) -> Result<(), &mut RawValue>

Attempts to add a new property to the map.

If the key was already associated with a value, returns a mutable reference to the old value and does not update the map.

pub fn use_fallbacks(&mut self)

Adds fallback values for certain common key-value pairs.

Used to obtain spec-compliant values for crate::property::IndentSize and crate::property::TabWidth.

pub fn use_fallbacks_legacy(&mut self)

Adds pre-0.9.0 fallback values for certain common key-value pairs.

This shouldn’t be used outside of narrow cases where compatibility with those older standards is required. Prefer Properties::use_fallbacks instead.

Trait Implementations

impl Clone for Properties

fn clone(&self) -> Properties

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Properties

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

Formats the value using the given formatter.

impl Default for Properties

fn default() -> Properties

Returns the “default value” for a type.

impl<K: AsRef<str>, V: Into<RawValue>> Extend<(K, V)> for Properties

fn extend<T: IntoIterator<Item = (K, V)>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<K: AsRef<str>, V: Into<RawValue>> FromIterator<(K, V)> for Properties

fn from_iter<T: IntoIterator<Item = (K, V)>>(iter: T) -> Self

Creates a value from an iterator.

impl<'a> IntoIterator for &'a Properties

type Item = <Iter<'a> as Iterator>::Item

The type of the elements being iterated over.

type IntoIter = Iter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a mut Properties

type Item = <IterMut<'a> as Iterator>::Item

The type of the elements being iterated over.

type IntoIter = IterMut<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for Properties

fn eq(&self, other: &Self) -> 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<'a> PropertiesSource for &'a Properties

fn apply_to( self, props: &mut Properties, _: impl AsRef<Path>, ) -> Result<(), Error>

Adds properties that apply to a file at the specified path to the provided Properties.

impl Eq for Properties