Struct Comment

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

A single comment from a CommitMessage

Implementations

impl<'a> Comment<'a>

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

Append one Comment onto another

This is for concatenating multiple Comment 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"))
)

pub fn is_legal_comment_char(character: char) -> bool

Tells you if a given comment character is a potential comment character

Example

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

fn from(comment: String) -> Self

Converts to this type from the input type.

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>