Enum git_checks::ChangelogStyle

pub enum ChangelogStyle {
    Directory {
        path: String,
        extension: Option<String>,
    },
    File {
        path: String,
    },
    Files {
        paths: Vec<String>,
    },
}

The style of changelog management in use.

Variants

Directory

A directory stores a file per changelog entry.

Fields of Directory

path: String

The path to the directory containing changelog entry files.

extension: Option<String>

The extension used for changelog files.

File

A file contains the changelog entries for a project.

Fields of File

path: String

The path to the changelog.

Files

A set of files containing the changelog entries for a project.

Fields of Files

paths: Vec<String>

The paths to the changelog files.

Methods

impl ChangelogStyle

pub fn file<P>(path: P) -> Self where
    P: Into<String>, 

A changelog stored in a file at a given path.

pub fn directory<P>(path: P, ext: Option<String>) -> Self where
    P: Into<String>, 

A directory containing many files, each with a changelog entry.

Entries may also be required to have a given extension.

pub fn files<P, I>(paths: I) -> Self where
    I: IntoIterator<Item = P>,
    P: Into<String>, 

A changelog stored in files at the given paths.

Trait Implementations

impl Clone for ChangelogStyle

fn clone(&self) -> ChangelogStyle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChangelogStyle

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

Formats the value using the given formatter.