Struct Comments

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

A collection of comments from a [CommitMessage]

Implementations

impl Comments<'_>

pub fn iter(&self) -> Iter<'_, Comment<'_>>

Iterate over the Comment in the Comments

Returns

An iterator over the comments in this collection

Examples

use mit_commit::{Comment, Comments};

let trailers = Comments::from(vec![
    Comment::from("# Comment 1"),
    Comment::from("# Comment 2"),
    Comment::from("# Comment 3"),
]);
let mut iterator = trailers.iter();

assert_eq!(iterator.next(), Some(&Comment::from("# Comment 1")));
assert_eq!(iterator.next(), Some(&Comment::from("# Comment 2")));
assert_eq!(iterator.next(), Some(&Comment::from("# Comment 3")));
assert_eq!(iterator.next(), None);

Trait Implementations

impl<'a> Clone for Comments<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Comments<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Comments<'a>

fn default() -> Comments<'a>

Returns the “default value” for a type.

impl From<Comments<'_>> for String

fn from(comments: Comments<'_>) -> Self

Convert Comments to a String

Arguments

• comments - The comments collection to convert

Returns

A String containing all comments joined with double newlines

impl<'a> From<Vec<Comment<'a>>> for Comments<'a>

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

Create Comments from a vector of Comment

Arguments

• comments - The vector of comments to create the collection from

Returns

A new Comments collection containing the provided comments

impl<'a> From<Vec<Fragment<'a>>> for Comments<'a>

fn from(ast: Vec<Fragment<'a>>) -> Self

Create Comments from a vector of Fragment

Arguments

• ast - The vector of fragments to filter for comments

Returns

A new Comments collection containing only the Comment fragments

impl<'a> IntoIterator for &'a Comments<'a>

fn into_iter(self) -> Self::IntoIter

Iterate over the Comment in the Comments

Returns

An iterator over references to the comments

Examples

use std::borrow::Borrow;

use mit_commit::{Comment, Comments};

let comments = Comments::from(vec![
    Comment::from("# Comment 1"),
    Comment::from("# Comment 2"),
    Comment::from("# Comment 3"),
]);
let comments_ref = comments.borrow();
let mut iterator = comments_ref.into_iter();

assert_eq!(iterator.next(), Some(&Comment::from("# Comment 1")));
assert_eq!(iterator.next(), Some(&Comment::from("# Comment 2")));
assert_eq!(iterator.next(), Some(&Comment::from("# Comment 3")));
assert_eq!(iterator.next(), None);

type IntoIter = Iter<'a, Comment<'a>>

Which kind of iterator are we turning this into?

type Item = &'a Comment<'a>

The type of the elements being iterated over.

impl<'a> IntoIterator for Comments<'a>

fn into_iter(self) -> Self::IntoIter

Iterate over the Comment in the Comments

Returns

An iterator that takes ownership of the comments

Examples

use mit_commit::{Comment, Comments};

let trailers = Comments::from(vec![
    Comment::from("# Comment 1"),
    Comment::from("# Comment 2"),
    Comment::from("# Comment 3"),
]);
let mut iterator = trailers.into_iter();

assert_eq!(iterator.next(), Some(Comment::from("# Comment 1")));
assert_eq!(iterator.next(), Some(Comment::from("# Comment 2")));
assert_eq!(iterator.next(), Some(Comment::from("# Comment 3")));
assert_eq!(iterator.next(), None);

type IntoIter = IntoIter<Comment<'a>>

Which kind of iterator are we turning this into?

type Item = Comment<'a>

The type of the elements being iterated over.

impl<'a> PartialEq for Comments<'a>

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

impl<'a> StructuralPartialEq for Comments<'a>