Struct unclog::Changelog

pub struct Changelog {
    pub unreleased: Option<ChangeSet>,
    pub releases: Vec<Release>,
    pub epilogue: Option<String>,
}

A log of changes for a specific project.

Fields

unreleased: Option<ChangeSet>

Unreleased changes don’t have version information associated with them.

releases: Vec<Release>

An ordered list of releases’ changes.

epilogue: Option<String>

Any additional content that must appear at the end of the changelog (e.g. historical changelog content prior to switching to unclog).

Implementations

impl Changelog

pub fn is_empty(&self) -> bool

Checks whether this changelog is empty.

pub fn init_dir<P: AsRef<Path>, E: AsRef<Path>>(
    path: P,
    epilogue_path: Option<E>
) -> Result<()>

Initialize a new (empty) changelog in the given path.

Creates the target folder if it doesn’t exist, and optionally copies an epilogue into it.

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

Attempt to read a full changelog from the given directory.

pub fn add_unreleased_entry<P, S, I, C>(
    path: P,
    section: S,
    id: I,
    content: C
) -> Result<()> where
    P: AsRef<Path>,
    S: AsRef<str>,
    I: AsRef<str>,
    C: AsRef<str>, 

Adds a changelog entry with the given ID to the specified section in the unreleased folder.

pub fn get_entry_path<P, R, S, I>(
    path: P,
    release: R,
    section: S,
    id: I
) -> PathBuf where
    P: AsRef<Path>,
    R: AsRef<str>,
    S: AsRef<str>,
    I: AsRef<str>, 

Compute the file system path to the entry with the given parameters.

pub fn prepare_release_dir<P: AsRef<Path>, S: AsRef<str>>(
    path: P,
    version: S
) -> Result<()>

Moves the unreleased folder from our changelog to a directory whose name is the given version.

Trait Implementations

impl Clone for Changelog

fn clone(&self) -> Changelog

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Changelog

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

Formats the value using the given formatter.

impl Display for Changelog

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

Formats the value using the given formatter.