Struct Bodies

Source

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

Expand description

A collection of user input [CommitMessage] text

§Examples

use mit_commit::{Bodies, Body, Subject};

let bodies: Vec<Body> = Vec::default();
assert_eq!(None, Bodies::from(bodies).first());

let bodies: Vec<Body> = vec![
    Body::from("First"),
    Body::from("Second"),
    Body::from("Third"),
];
assert_eq!(Some(Body::from("First")), Bodies::from(bodies).first());

Implementations§

Source §

impl<'a> Bodies<'a>

Source

pub fn first(&self) -> Option<Body<'_>>

Get the first Body in this list of Bodies

§Examples

use mit_commit::{Bodies, Body, Subject};

let bodies: Vec<Body> = Vec::default();
assert_eq!(None, Bodies::from(bodies).first());

let bodies: Vec<Body> = vec![
    Body::from("First"),
    Body::from("Second"),
    Body::from("Third"),
];
assert_eq!(Some(Body::from("First")), Bodies::from(bodies).first());

Source

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

Iterate over the Body in the Bodies

§Examples

use mit_commit::{Bodies, Body};
let bodies = Bodies::from(vec![
    Body::from("Body 1"),
    Body::from("Body 2"),
    Body::from("Body 3"),
]);
let mut iterator = bodies.iter();

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

Trait Implementations§

Source §

impl<'a> Clone for Bodies<'a>

Source §

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

Returns a copy of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl<'a> Debug for Bodies<'a>

Source §

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

Formats the value using the given formatter. Read more

Source §

impl<'a> Default for Bodies<'a>

Source §

fn default() -> Bodies<'a>

Returns the “default value” for a type. Read more

Source §

impl<'a> Display for Bodies<'a>

Source §

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

Render the Bodies as text

§Examples

use mit_commit::{Bodies, Body};
let bodies = Bodies::from(vec![
    Body::from("Body 1"),
    Body::from("Body 2"),
    Body::from("Body 3"),
]);

assert_eq!(format!("{}", bodies), "Body 1\n\nBody 2\n\nBody 3");

Source §

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

Source §

fn from(bodies: Bodies<'_>) -> Self

Converts to this type from the input type.

Source §

impl<'a> From<Vec<Body<'a>>> for Bodies<'a>

Source §

fn from(bodies: Vec<Body<'a>>) -> Self

Combine a Vec of Body into Bodies

§Examples

use mit_commit::{Bodies, Body};
let bodies = Bodies::from(vec![
    Body::from("Body 1"),
    Body::from("Body 2"),
    Body::from("Body 3"),
]);
let mut iterator = bodies.into_iter();

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

Source §

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

Source §

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

Converts to this type from the input type.

Source §

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

Source §

fn into_iter(self) -> Self::IntoIter

Iterate over the Body in the Bodies

§Examples

use std::borrow::Borrow;

use mit_commit::{Bodies, Body};
let bodies = Bodies::from(vec![
    Body::from("Body 1"),
    Body::from("Body 2"),
    Body::from("Body 3"),
]);
let bodies_ref = bodies.borrow();
let mut iterator = bodies_ref.into_iter();

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

Source §

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

Which kind of iterator are we turning this into?

Source §

type Item = &'a Body<'a>

The type of the elements being iterated over.

Source §

impl<'a> IntoIterator for Bodies<'a>

Source §

fn into_iter(self) -> Self::IntoIter

Iterate over the Body in the Bodies

§Examples

use mit_commit::{Bodies, Body};
let bodies = Bodies::from(vec![
    Body::from("Body 1"),
    Body::from("Body 2"),
    Body::from("Body 3"),
]);
let mut iterator = bodies.into_iter();

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