Struct mit_commit::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

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());

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

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

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

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");

Performs the conversion.

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);

Performs the conversion.

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);

Which kind of iterator are we turning this into?

The type of the elements being iterated over.

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

This method tests for !=.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

Converts the given value to a String. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.