Struct mit_commit::Trailers

pub struct Trailers { /* fields omitted */ }

A Collection of Trailer

Implementations

impl Trailers

#[must_use]pub fn iter(&self) -> Iter<Trailer>

Iterate over the trailers

Examples

use mit_commit::Trailer;
use mit_commit::Trailers;
let trailers = Trailers::from(vec![
    Trailer::new("Co-authored-by", "Billie Thompson <billie@example.com>"),
    Trailer::new("Co-authored-by", "Someone Else <someone@example.com>"),
    Trailer::new("Relates-to", "#124"),
]);
let mut iterator = trailers.iter();

assert_eq!(
    iterator.next(),
    Some(&Trailer::new(
        "Co-authored-by",
        "Billie Thompson <billie@example.com>"
    ))
);
assert_eq!(
    iterator.next(),
    Some(&Trailer::new(
        "Co-authored-by",
        "Someone Else <someone@example.com>"
    ))
);
assert_eq!(iterator.next(), Some(&Trailer::new("Relates-to", "#124")));
assert_eq!(iterator.next(), None);

#[must_use]pub fn len(&self) -> usize

How many trailers are there

Examples

use mit_commit::Trailer;
use mit_commit::Trailers;
let trailers = Trailers::from(vec![
    Trailer::new("Co-authored-by", "Billie Thompson <billie@example.com>"),
    Trailer::new("Co-authored-by", "Someone Else <someone@example.com>"),
]);

assert_eq!(trailers.len(), 2)

#[must_use]pub fn is_empty(&self) -> bool

Are there no trailers

Examples

use mit_commit::Trailer;
use mit_commit::Trailers;
assert_eq!(
    Trailers::from(vec![
        Trailer::new("Co-authored-by", "Billie Thompson <billie@example.com>"),
        Trailer::new("Co-authored-by", "Someone Else <someone@example.com>"),
    ])
    .is_empty(),
    false
);

let trailers: Vec<Trailer> = Vec::new();
assert_eq!(Trailers::from(trailers).is_empty(), true)

Trait Implementations

impl Clone for Trailers

fn clone(&self) -> Trailers

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Trailers

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

Formats the value using the given formatter.

impl From<Trailers> for String

fn from(trailers: Trailers) -> Self

Performs the conversion.

impl From<Vec<Fragment>> for Trailers

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

Performs the conversion.

impl From<Vec<Trailer>> for Trailers

fn from(trailers: Vec<Trailer>) -> Self

Performs the conversion.

impl PartialEq<Trailers> for Trailers

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

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

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

This method tests for !=.

impl StructuralPartialEq for Trailers