Struct unclog::ChangeSetSection

pub struct ChangeSetSection {
    pub id: String,
    pub title: String,
    pub entries: Vec<Entry>,
    pub component_sections: Vec<ComponentSection>,
}

A single section in a set of changes.

For example, the “FEATURES” or “BREAKING CHANGES” section.

Fields

id: String

Original ID of this change set section (the folder name).

title: String

A short, descriptive title for this section (e.g. “BREAKING CHANGES”).

entries: Vec<Entry>

General entries in the change set section.

component_sections: Vec<ComponentSection>

Entries associated with a specific component/package/submodule.

Implementations

impl ChangeSetSection

pub fn is_empty(&self) -> bool

Returns whether or not this section is empty.

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

where P: AsRef<Path>,

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

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

Render this change set section to a string using the given configuration.

Trait Implementations

impl Clone for ChangeSetSection

fn clone(&self) -> ChangeSetSection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChangeSetSection

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

Formats the value using the given formatter.

impl Hash for ChangeSetSection

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ChangeSetSection

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

impl StructuralPartialEq for ChangeSetSection