Struct unclog::ChangeSet

pub struct ChangeSet {
    pub maybe_summary: Option<String>,
    pub sections: Vec<ChangeSetSection>,
}

A set of changes, either associated with a release or not.

Fields

maybe_summary: Option<String>

An optional high-level summary of the set of changes.

sections: Vec<ChangeSetSection>

The sections making up the change set.

Implementations

impl ChangeSet

pub fn is_empty(&self) -> bool

Returns true if this change set has no summary and no entries associated with it.

pub fn are_sections_empty(&self) -> bool

Returns whether or not all the sections are empty.

pub fn read_from_dir<P>(config: &Config, path: P) -> Result<Self>where P: AsRef<Path>,

Attempt to read a single change set from the given directory.

pub fn read_from_dir_opt<P>(config: &Config, path: P) -> Result<Option<Self>>where P: AsRef<Path>,

Attempt to read a single change set from the given directory, like ChangeSet::read_from_dir, but return Option::None if the directory does not exist.

pub fn render(&self, config: &Config) -> String

Trait Implementations

impl Clone for ChangeSet

fn clone(&self) -> ChangeSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChangeSet

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

Formats the value using the given formatter.