Struct ValueMut

pub struct ValueMut<'borrow, 'lookup, 'event> { /* private fields */ }

An intermediate representation of a mutable value obtained from a File.

Implementations

impl<'borrow, 'event> ValueMut<'borrow, '_, 'event>

pub fn get(&self) -> Result<Cow<'_, BStr>, Error>

Returns the actual value. This is computed each time this is called requiring an allocation for multi-line values.

pub fn set_string(&mut self, input: impl AsRef<str>)

Update the value to the provided one. This modifies the value such that the Value event(s) are replaced with a single new event containing the new value.

pub fn set<'a>(&mut self, input: impl Into<&'a BStr>)

Update the value to the provided one. This modifies the value such that the Value event(s) are replaced with a single new event containing the new value.

pub fn delete(&mut self)

Removes the value. Does nothing when called multiple times in succession.

pub fn section(&self) -> &Section<'event>

Return the section containing the value.

pub fn into_section_mut(self) -> SectionMut<'borrow, 'event>

Convert this value into its owning mutable section.

Trait Implementations

impl<'borrow, 'lookup, 'event> Debug for ValueMut<'borrow, 'lookup, 'event>

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

Formats the value using the given formatter.

impl<'borrow, 'lookup, 'event> Hash for ValueMut<'borrow, 'lookup, 'event>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'borrow, 'lookup, 'event> Ord for ValueMut<'borrow, 'lookup, 'event>

fn cmp(&self, other: &ValueMut<'borrow, 'lookup, 'event>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'borrow, 'lookup, 'event> PartialEq for ValueMut<'borrow, 'lookup, 'event>

fn eq(&self, other: &ValueMut<'borrow, 'lookup, 'event>) -> 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<'borrow, 'lookup, 'event> PartialOrd for ValueMut<'borrow, 'lookup, 'event>

fn partial_cmp( &self, other: &ValueMut<'borrow, 'lookup, 'event>, ) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'borrow, 'lookup, 'event> Eq for ValueMut<'borrow, 'lookup, 'event>

impl<'borrow, 'lookup, 'event> StructuralPartialEq for ValueMut<'borrow, 'lookup, 'event>