Struct Trailers

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

A Collection of Trailer

Implementations

impl Trailers<'_>

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

Iterate over the Trailers

Examples

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

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

pub const fn len(&self) -> usize

How many Trailers are there

Examples

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

assert_eq!(trailers.len(), 2)

pub const fn is_empty(&self) -> bool

Are there no Trailers

Examples

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

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

Trait Implementations

impl<'a> Clone for Trailers<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Trailers<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Trailers<'a>

fn default() -> Trailers<'a>

Returns the “default value” for a type.

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

fn from(trailers: Trailers<'a>) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<'a> From<Vec<Trailer<'a>>> for Trailers<'a>

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

Converts to this type from the input type.

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

fn into_iter(self) -> Self::IntoIter

Iterate over the Trailers

Examples

use std::borrow::Borrow;

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

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

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

Which kind of iterator are we turning this into?

type Item = &'a Trailer<'a>

The type of the elements being iterated over.

impl<'a> IntoIterator for Trailers<'a>

fn into_iter(self) -> Self::IntoIter

Iterate over the Trailers

Examples

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

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

type Item = Trailer<'a>

The type of the elements being iterated over.

type IntoIter = IntoIter<Trailer<'a>>

Which kind of iterator are we turning this into?

impl<'a> PartialEq for Trailers<'a>

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

impl<'a> StructuralPartialEq for Trailers<'a>