Struct Trailers

pub struct Trailers { /* private fields */ }

A Git commit’s set of trailers that are left in the commit’s message.

Trailers are key/value pairs in the last paragraph of a message, not including any patches or conflicts that may be present.

Usage

To construct Trailers, you can use Trailers::parse or its FromStr implementation.

To iterate over the trailers, you can use Trailers::iter.

To render the trailers to a String, you can use Trailers::to_string or its Display implementation (note that it will default to using ": " as the separator.

Examples

Add new functionality

Making code better with new functionality.

X-Signed-Off-By: Alex Sellier
X-Co-Authored-By: Fintan Halpenny

The trailers in the above example are:

X-Signed-Off-By: Alex Sellier
X-Co-Authored-By: Fintan Halpenny

Implementations

impl Trailers

pub fn parse(message: &str) -> Result<Trailers, Error>

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

pub fn to_string<'a, S>(&self, sep: S) -> String

where S: Separator<'a>,

Trait Implementations

impl Display for Trailers

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

Formats the value using the given formatter.

impl FromStr for Trailers

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Trailers, <Trailers as FromStr>::Err>

Parses a string s to return a value of this type.