Struct git_config::parser::ParsedComment

pub struct ParsedComment<'a> {
    pub comment_tag: char,
    pub comment: Cow<'a, [u8]>,
}

A parsed comment event containing the comment marker and comment.

Fields

comment_tag: char

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

comment: Cow<'a, [u8]>

The parsed comment.

Implementations

impl ParsedComment<'_>

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

Coerces into an owned instance. This differs from the standard clone implementation as calling clone will not copy the borrowed variant, while this method will. In other words:

Borrow type	.clone()	to_owned()
Borrowed	Borrowed	Owned
Owned	Owned	Owned

This can be most effectively seen by the differing lifetimes between the two. This method guarantees a 'static lifetime, while clone does not.

Trait Implementations

impl<'a> Clone for ParsedComment<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ParsedComment<'a>

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

Formats the value using the given formatter.

impl<'a> Default for ParsedComment<'a>

fn default() -> ParsedComment<'a>

Returns the “default value” for a type.

impl Display for ParsedComment<'_>

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

Note that this is a best-effort attempt at printing an comment. If there are non UTF-8 values in your config, this will NOT render as read.

impl From<&'_ ParsedComment<'_>> for Vec<u8>

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

Performs the conversion.

impl From<ParsedComment<'_>> for Vec<u8>

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

Performs the conversion.

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

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for ParsedComment<'a>

fn cmp(&self, other: &ParsedComment<'a>) -> 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<'a> PartialEq<ParsedComment<'a>> for ParsedComment<'a>

fn eq(&self, other: &ParsedComment<'a>) -> bool

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

fn ne(&self, other: &ParsedComment<'a>) -> bool

This method tests for !=.

impl<'a> PartialOrd<ParsedComment<'a>> for ParsedComment<'a>

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

impl<'a> StructuralEq for ParsedComment<'a>

impl<'a> StructuralPartialEq for ParsedComment<'a>