Struct git_config::file::MutableSection

pub struct MutableSection<'borrow, 'event> { /* fields omitted */ }

A opaque type that represents a mutable reference to a section.

Implementations

impl<'borrow, 'event> MutableSection<'borrow, 'event>

pub fn push(&mut self, key: Key<'event>, value: Cow<'event, [u8]>)

Adds an entry to the end of this section.

pub fn pop(&mut self) -> Option<(Key<'_>, Cow<'event, [u8]>)>

Removes all events until a key value pair is removed. This will also remove the whitespace preceding the key value pair, if any is found.

pub fn set(
    &mut self,
    key: Key<'event>,
    value: Cow<'event, [u8]>
) -> Option<Cow<'event, [u8]>>

Sets the last key value pair if it exists, or adds the new value. Returns the previous value if it replaced a value, or None if it adds the value.

pub fn remove(&mut self, key: &Key<'event>) -> Option<Cow<'event, [u8]>>

Removes the latest value by key and returns it, if it exists.

pub fn push_newline(&mut self)

Adds a new line event. Note that you don’t need to call this unless you’ve disabled implicit newlines.

pub fn implicit_newline(&mut self, on: bool)

Enables or disables automatically adding newline events after adding a value. This is enabled by default.

pub fn set_whitespace(&mut self, num: usize)

Sets the number of spaces before the start of a key value. By default, this is set to two. Set to 0 to disable adding whitespace before a key value.

pub const fn whitespace(&self) -> usize

Returns the number of whitespace this section will insert before the beginning of a key.

Methods from Deref<Target = SectionBody<'event>>

pub fn value(&self, key: &Key<'_>) -> Option<Cow<'event, [u8]>>

Retrieves the last matching value in a section with the given key. Returns None if the key was not found.

pub fn value_as<T: TryFrom<Cow<'event, [u8]>>>(
    &self,
    key: &Key<'_>
) -> Result<T, GitConfigError<'event>>

Retrieves the last matching value in a section with the given key, and attempts to convert the value into the provided type.

Errors

Returns an error if the key was not found, or if the conversion failed.

pub fn values(&self, key: &Key<'_>) -> Vec<Cow<'event, [u8]>>

Retrieves all values that have the provided key name. This may return an empty vec, which implies there was values with the provided key.

pub fn values_as<T: TryFrom<Cow<'event, [u8]>>>(
    &self,
    key: &Key<'_>
) -> Result<Vec<T>, GitConfigError<'event>>

Retrieves all values that have the provided key name. This may return an empty vec, which implies there was values with the provided key.

Errors

Returns an error if the conversion failed.

pub fn keys(&self) -> impl Iterator<Item = &Key<'event>>

Returns an iterator visiting all keys in order.

pub fn contains_key(&self, key: &Key<'_>) -> bool

Checks if the section contains the provided key.

pub fn len(&self) -> usize

Returns the number of entries in the section.

pub fn is_empty(&self) -> bool

Returns if the section is empty.

Trait Implementations

impl<'borrow, 'event> Debug for MutableSection<'borrow, 'event>

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

Formats the value using the given formatter.

impl<'event> Deref for MutableSection<'_, 'event>

type Target = SectionBody<'event>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'borrow, 'event> Hash for MutableSection<'borrow, '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, 

Feeds a slice of this type into the given Hasher.

impl<'borrow, 'event> Ord for MutableSection<'borrow, 'event>

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<'borrow, 'event> PartialEq<MutableSection<'borrow, 'event>> for MutableSection<'borrow, 'event>

fn eq(&self, other: &MutableSection<'borrow, 'event>) -> bool

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

fn ne(&self, other: &MutableSection<'borrow, 'event>) -> bool

This method tests for !=.

impl<'borrow, 'event> PartialOrd<MutableSection<'borrow, 'event>> for MutableSection<'borrow, 'event>

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<'borrow, 'event> Eq for MutableSection<'borrow, 'event>

impl<'borrow, 'event> StructuralEq for MutableSection<'borrow, 'event>

impl<'borrow, 'event> StructuralPartialEq for MutableSection<'borrow, 'event>