Struct gix_config::file::Section

pub struct Section<'a> { /* private fields */ }

A section in a git-config file, like [core] or [remote "origin"], along with all of its keys.

Implementations

impl<'a> Section<'a>

Instantiation and conversion

pub fn new( name: impl Into<Cow<'a, str>>, subsection: impl Into<Option<Cow<'a, BStr>>>, meta: impl Into<OwnShared<Metadata>> ) -> Result<Self, Error>

Create a new section with the given name and optional, subsection, meta-data and an empty body.

impl<'a> Section<'a>

Access

pub fn header(&self) -> &Header<'a>

Return our header.

pub fn id(&self) -> SectionId

Return the unique id of the section, for use with the *_by_id() family of methods in gix_config::File.

pub fn body(&self) -> &Body<'a>

Return our body, containing all keys and values.

pub fn to_bstring(&self) -> BString

Serialize this type into a BString for convenience.

Note that to_string() can also be used, but might not be lossless.

pub fn write_to(&self, out: &mut dyn Write) -> Result<()>

Stream ourselves to the given out, in order to reproduce this section mostly losslessly as it was parsed.

pub fn meta(&self) -> &Metadata

Return additional information about this sections origin.

pub fn to_mut(&mut self, newline: SmallVec<[u8; 2]>) -> SectionMut<'_, 'a>

Returns a mutable version of this section for adjustment of values.

Methods from Deref<Target = Body<'a>>

pub fn value(&self, key: impl AsRef<str>) -> Option<Cow<'_, BStr>>

Retrieves the last matching value in a section with the given key, if present.

Note that we consider values without key separator = non-existing.

pub fn value_implicit(&self, key: &str) -> Option<Option<Cow<'_, BStr>>>

Retrieves the last matching value in a section with the given key, if present, and indicates an implicit value with Some(None), and a non-existing one as None

pub fn values(&self, key: &str) -> Vec<Cow<'_, BStr>>

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

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

Returns an iterator visiting all keys in order.

pub fn contains_key(&self, key: &str) -> bool

Returns true if the section contains the provided key.

pub fn num_values(&self) -> usize

Returns the number of values in the section.

pub fn is_void(&self) -> bool

Returns if the section is empty. Note that this may count whitespace, see num_values() for another way to determine semantic emptiness.

Trait Implementations

impl<'a> Clone for Section<'a>

fn clone(&self) -> Section<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Section<'a>

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

Formats the value using the given formatter.

impl<'a> Deref for Section<'a>

type Target = Body<'a>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a> Hash for Section<'a>

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<'a> Ord for Section<'a>

fn cmp(&self, other: &Section<'a>) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl<'a> PartialEq for Section<'a>

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

fn partial_cmp(&self, other: &Section<'a>) -> 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<'a> Eq for Section<'a>

impl<'a> StructuralPartialEq for Section<'a>