Struct gix_config::parse::Comment

pub struct Comment<'a> {
    pub tag: u8,
    pub text: Cow<'a, BStr>,
}

A parsed comment containing the comment marker and comment.

Fields

tag: u8

The comment marker used. This is either a semicolon or octothorpe/hash.

text: Cow<'a, BStr>

The parsed comment.

Implementations

impl Comment<'_>

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

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

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<()>

Stream ourselves to the given out, in order to reproduce this comment losslessly.

Trait Implementations

impl<'a> Clone for Comment<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Comment<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Comment<'a>

fn default() -> Comment<'a>

Returns the “default value” for a type.

impl Display for Comment<'_>

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

Formats the value using the given formatter.

impl From<&Comment<'_>> for BString

fn from(c: &Comment<'_>) -> Self

Converts to this type from the input type.

impl From<Comment<'_>> for BString

fn from(c: Comment<'_>) -> Self

Converts to this type from the input type.

impl<'a> Hash for Comment<'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 Comment<'a>

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

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

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

impl<'a> StructuralPartialEq for Comment<'a>