Struct Comment

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

A single comment from a CommitMessage

Implementations

impl Comment<'_>

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

Append one Comment onto another

Arguments

• additional - The comment to append to this one

Returns

A new comment with the content of both comments separated by a newline

Examples

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

pub fn is_legal_comment_char(character: char) -> bool

Checks if a given character is a valid comment character

Arguments

• character - The character to check

Returns

true if the character is a valid comment character, false otherwise

Examples

use mit_commit::Comment;

assert!(!Comment::is_legal_comment_char('?'));
assert!(Comment::is_legal_comment_char('#'));

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> From<&'a str> for Comment<'a>

fn from(comment: &'a str) -> Self

Create a Comment from a string slice

Arguments

• comment - The string slice to create the comment from

Returns

A new Comment containing the provided string

impl<'a> From<Comment<'a>> for Fragment<'a>

fn from(comment: Comment<'a>) -> Self

Create a Fragment from a Comment

Arguments

• comment - The comment to convert into a fragment

Returns

A new Fragment::Comment variant containing the provided comment

Examples

use mit_commit::{Comment, Fragment};

let comment = Comment::from("# Example comment");
let fragment = Fragment::from(comment.clone());
assert_eq!(fragment, Fragment::Comment(comment));

impl<'a> From<Comment<'a>> for String

fn from(comment: Comment<'a>) -> Self

Convert a Comment to a String

Arguments

• comment - The comment to convert

Returns

A String containing the comment’s text

impl<'a> From<Cow<'a, str>> for Comment<'a>

fn from(comment: Cow<'a, str>) -> Self

Create a Comment from a Cow<_, str>

Arguments

• comment - The string content to create the comment from

Returns

A new Comment containing the provided string

impl From<String> for Comment<'_>

fn from(comment: String) -> Self

Create a Comment from a String

Arguments

• comment - The string to create the comment from

Returns

A new Comment containing the provided string

impl<'a> PartialEq for Comment<'a>

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

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