Struct MessageRef

pub struct MessageRef<'a> {
    pub title: &'a BStr,
    pub body: Option<&'a BStr>,
}

A parsed commit message that assumes a title separated from the body by two consecutive newlines.

Titles can have any amount of whitespace

Fields

title: &'a BStr

The title of the commit, as separated from the body with two consecutive newlines. The newlines are not included.

body: Option<&'a BStr>

All bytes not consumed by the title, excluding the separating newlines.

The body is None if there was now title separation or the body was empty after the separator.

Implementations

impl<'a> MessageRef<'a>

pub fn from_bytes(input: &'a [u8]) -> Self

Parse the given input as message.

Note that this cannot fail as everything will be interpreted as title if there is no body separator.

pub fn summary(&self) -> Cow<'a, BStr>

Produce a short commit summary for the message title.

This means the following

• Take the subject line which is delimited by two newlines (\n\n)
• transform intermediate consecutive whitespace including \r into one space

The resulting summary will have folded whitespace before a newline into spaces and stopped that process once two consecutive newlines are encountered.

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

Further parse the body into into non-trailer and trailers, which can be iterated from the returned BodyRef.

Trait Implementations

impl<'a> Clone for MessageRef<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for MessageRef<'a>

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

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for MessageRef<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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

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

Restrict a value to a certain interval.

impl<'a> PartialEq for MessageRef<'a>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialOrd for MessageRef<'a>

fn partial_cmp(&self, other: &MessageRef<'a>) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a> Serialize for MessageRef<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> Copy for MessageRef<'a>

impl<'a> Eq for MessageRef<'a>

impl<'a> StructuralPartialEq for MessageRef<'a>