Struct Configuration 

pub struct Configuration {
    pub delimiter: String,
    pub grammar: Grammar,
    pub buckets: Vec<String>,
    pub fallback_bucket: Option<String>,
    pub renderer: Renderer,
}

The harvest configuration.

git-harvest has no separate configuration file: these settings live in the CHANGELOG document, and Configuration::default is what git-harvest init writes into a fresh one.

Fields

delimiter: String

The token separating a bucket from its entry under Grammar::Delimited.

grammar: Grammar

How a commit subject encodes its bucket.

buckets: Vec<String>

The buckets a change may be filed under, in rendering order.

fallback_bucket: Option<String>

The bucket for a change whose commit names none, where one is wanted.

renderer: Renderer

The shape the assembled CHANGELOG is rendered in.

Implementations

impl Configuration

pub fn parse(&self, subject: &str) -> Option<(String, String)>

Parse a commit subject into a (bucket, entry text) pair.

Returns None when the subject names no known bucket and no fallback_bucket is set, or when the entry text is empty. Under Grammar::Delimited the bucket is what precedes delimiter; under Grammar::Bracketed it is what a leading [..] encloses.

Trait Implementations

impl Clone for Configuration

fn clone(&self) -> Configuration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Configuration

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

Formats the value using the given formatter.

impl Default for Configuration

fn default() -> Self

The defaults git-harvest init writes: the ::= delimiter, the delimited grammar, the six Keep a Changelog buckets, no fallback, and Markdown rendering.

impl<'de> Deserialize<'de> for Configuration

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Configuration

impl PartialEq for Configuration

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Configuration

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Configuration