Struct git_repository::config::parse::section::Header

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

A parsed section header, containing a name and optionally a subsection name.

Implementations

impl<'a> Header<'a>

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

Instantiate a new header either with a section name, e.g. “core” serializing to ["core"] or [remote "origin"] for subsection being “origin” and name being “remote”.

impl Header<'_>

pub fn is_legacy(&self) -> bool

Return true if this is a header like [legacy.subsection], or false otherwise.

pub fn subsection_name(&self) -> Option<&BStr>

Return the subsection name, if present, i.e. “origin” in [remote "origin"].

It is parsed without quotes, and with escapes folded into their resulting characters. Thus during serialization, escapes and quotes must be re-added. This makes it possible to use Event data for lookups directly.

pub fn name(&self) -> &BStr

Return the name of the header, like “remote” in [remote "origin"].

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: impl Write) -> Result<(), Error>

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

pub fn to_owned(&self) -> Header<'static>

Turn this instance into a fully owned one with 'static lifetime.

Trait Implementations

impl<'a> Clone for Header<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Header<'a>

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

Formats the value using the given formatter.

impl Display for Header<'_>

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

Formats the value using the given formatter.

impl<'a> From<Header<'a>> for Event<'a>

fn from(header: Header<'_>) -> Event<'_>

Converts to this type from the input type.

impl<'a> Hash for Header<'a>

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

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 Header<'a>

fn cmp(&self, other: &Header<'a>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<'a> PartialEq<Header<'a>> for Header<'a>

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

fn partial_cmp(&self, other: &Header<'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 Header<'a>

impl<'a> StructuralEq for Header<'a>

impl<'a> StructuralPartialEq for Header<'a>