Struct mit_commit::Comments

pub struct Comments { /* fields omitted */ }

A collection of comments from a [CommitMessage]

Implementations

impl Comments

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

Iterate over the Comment in 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.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 Clone for Comments

fn clone(&self) -> Comments

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Comments

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

Formats the value using the given formatter.

impl Default for Comments

fn default() -> Comments

Returns the “default value” for a type.

impl From<Comments> for String

fn from(comments: Comments) -> Self

Performs the conversion.

impl From<Vec<Comment, Global>> for Comments

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

Performs the conversion.

impl From<Vec<Fragment, Global>> for Comments

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

Performs the conversion.

impl IntoIterator for Comments

fn into_iter(self) -> Self::IntoIter

Iterate over the Comment in 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>

Which kind of iterator are we turning this into?

type Item = Comment

The type of the elements being iterated over.

impl PartialEq<Comments> for Comments

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

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

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

This method tests for !=.

impl StructuralPartialEq for Comments