Struct unclog::Config

pub struct Config {

    pub maybe_project_url: Option<Url>,
    pub change_template: String,
    pub wrap: u16,
    pub heading: String,
    pub bullet_style: BulletStyle,
    pub empty_msg: String,
    pub prologue_filename: String,
    pub epilogue_filename: String,
    pub sort_releases_by: ReleaseSortingConfig,
    pub release_date_formats: ReleaseDateFormats,
    pub unreleased: UnreleasedConfig,
    pub change_sets: ChangeSetsConfig,
    pub change_set_sections: ChangeSetSectionsConfig,
    pub components: ComponentsConfig,
}

Configuration options relating to the generation of a changelog.

Fields

maybe_project_url: Option<Url>

The URL of the project. This helps facilitate automatic content generation when supplying an issue or PR number.

change_template: String

The path to a file containing the change template to use when automatically adding new changelog entries. Relative to the .changelog folder.

wrap: u16

Wrap entries automatically to a specific number of characters per line.

heading: String

The heading to use at the beginning of the changelog we generate.

bullet_style: BulletStyle

What style of bullet should we use when generating changelog entries?

empty_msg: String

The message to use when the changelog is empty.

prologue_filename: String

The filename (relative to the .changelog folder) of the file containing content to be inserted at the beginning of the generated changelog.

epilogue_filename: String

The filename (relative to the .changelog folder) of the file containing content to be appended to the end of the generated changelog.

sort_releases_by: ReleaseSortingConfig

Sort releases by the given properties.

release_date_formats: ReleaseDateFormats

An ordered list of possible formats to expect when parsing release summaries to establish release dates.

unreleased: UnreleasedConfig

Configuration relating to unreleased changelog entries.

change_sets: ChangeSetsConfig

Configuration relating to sets of changes.

change_set_sections: ChangeSetSectionsConfig

Configuration relating to change set sections.

components: ComponentsConfig

Configuration relating to components/submodules.

Implementations

impl Config

pub fn read_from_file<P: AsRef<Path>>(path: P) -> Result<Self>

Attempt to read the configuration from the given file.

If the given file does not exist, this method does not fail: it returns a Config object with all of the default values set.

At present, only TOML format is supported.

pub fn write_to_file<P: AsRef<Path>>(&self, path: P) -> Result<()>

Attempt to save the configuration to the given file.

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

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

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

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

This method 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