Struct Config

pub struct Config {
    pub categories: Vec<String>,
    pub category_delimiters: Vec<String>,
    pub colored_output: bool,
    pub default_template: Option<String>,
    pub enable_debug: bool,
    pub excluded_commit_tags: Vec<String>,
    pub enable_footers: bool,
    pub show_commit_hash: bool,
    pub show_prefix: bool,
    pub sort_by: String,
    pub template_prefix: String,
}

The configuration structure for git-journal.

Fields

categories: Vec<String>

Specifies the available categories for the commit message

category_delimiters: Vec<String>

Set the characters where the categories are wrapped in

colored_output: bool

Set to false if the output should not be colored

default_template: Option<String>

Specifies the default template. Will be used for tag validation and printing.

enable_debug: bool

Show or hide the debug messages like [OKAY] ... or [INFO] ...

excluded_commit_tags: Vec<String>

Excluded tags in an array, e.g. “internal”

enable_footers: bool

Enable or disable the output and accumulation of commit footers

show_commit_hash: bool

Show or hide the commit hash for every entry

show_prefix: bool

Show or hide the commit message prefix, e.g. JIRA-1234

sort_by: String

Sort the commits during the output by “date” (default) or “name”

template_prefix: String

Commit message template prefix which will be added during commit preparation

Implementations

impl Config

pub fn new() -> Self

Constructs a new Config with default values.

Examples

use gitjournal::Config;
let config = Config::new();

pub fn save_default_config(&self, path: &str) -> Result<String, Error>

Save the default configuration file in a certain path.

Examples

use gitjournal::Config;
Config::new()
    .save_default_config(".")
    .expect("Could not save config.");

Errors

When toml encoding or file creation failed.

pub fn load(&mut self, path: &str) -> Result<(), Error>

Load a configuration file from a certain path.

Examples

use gitjournal::Config;
Config::new().load(".").expect("Could not load config.");

Errors

When toml decoding or file opening failed.

pub fn is_default_config(&self) -> bool

Check if the configuration matches with the default one.

Examples

use gitjournal::Config;
assert_eq!(Config::new().is_default_config(), true);

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Config

fn eq(&self, other: &Config) -> 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 Serialize for Config

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 Config