Struct mit_commit::Comment

pub struct Comment { /* fields omitted */ }

A single comment from a CommitMessage

Implementations

impl Comment

#[must_use]

pub fn append(&self, additional: &Comment) -> Comment

Append one comment onto another

This is for concatenating multiple comments together

Example

use indoc::indoc;
use mit_commit::Comment;

assert_eq!(
    Comment::from(indoc!(
        "
        Example 1
        Example 2"
    )),
    Comment::from("Example 1").append(&Comment::from("Example 2"))
)

Trait Implementations

impl Clone for Comment

fn clone(&self) -> Comment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Comment

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

Formats the value using the given formatter.

impl From<&'_ str> for Comment

fn from(comment: &str) -> Self

Performs the conversion.

impl From<String> for Comment

fn from(comment: String) -> Self

Performs the conversion.

impl PartialEq<Comment> for Comment

fn eq(&self, other: &Comment) -> bool

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

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

This method tests for !=.

impl StructuralPartialEq for Comment