Enum Section 

pub enum Section {
    Verbatim {
        text: String,
        generated: bool,
    },
    Release {
        name: Version,
        date: Option<Zoned>,
        heading_level: usize,
        version_prefix: String,
        unknown: String,
        removed_messages: Vec<ObjectId>,
        segments: Vec<Segment>,
    },
}

Variants

Verbatim

A part of a changelog which couldn’t be understood and is taken in verbatim. This is usually the pre-amble of the changelog or a custom footer.

Fields

text: String

The section text, unchanged, up until the next Release.

generated: bool

True if this is not created by a human

Release

A segment describing a particular release

Fields

name: Version

date: Option<Zoned>

heading_level: usize

the amount of # in front of the heading denoting the release name

version_prefix: String

What came right before the version

unknown: String

text of events of everything we couldn’t parse

removed_messages: Vec<ObjectId>

Removed git conventional messages parsed back from html tags. These may live without a headline, to delete the headline.

segments: Vec<Segment>

portions of a release

Implementations

impl Section

pub fn merge(&mut self, src: Section) -> Result<()>

impl Section

pub const DEFAULT_PREFIX: &'static str = "v"

pub fn from_history_segment( package: &Package, segment: &Segment<'_>, repo: &Repository, selection: Selection, prev_segment: Option<&Segment<'_>>, ) -> Self

impl Section

pub const UNKNOWN_TAG_START: &'static str = "<csr-unknown>"

pub const UNKNOWN_TAG_END: &'static str = "<csr-unknown/>"

pub const READONLY_TAG: &'static str = "<csr-read-only-do-not-edit/>\n"

pub const NL: &'static str = "\n"

pub fn write_to( &self, out: impl Write, link_mode: &Linkables, components: Components, capitalize_commit: bool, ) -> Result

Note that headline should be enabled by default as it will break parsing to some extend. It’s a special case for tag objects.

impl Section

pub fn is_essential(&self) -> bool

Returns true if there are segments that would always be present as they carry essential information about the release.

pub fn is_probably_lacking_user_edits(&self) -> bool

Returns true if there is no user-made section, or no edit by users in conventional segments at all. Note that we can’t tell if existing messages were edited (because we don’t try hard enough).

Trait Implementations

impl Clone for Section

fn clone(&self) -> Section

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Section

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

Formats the value using the given formatter.

impl PartialEq for Section

fn eq(&self, other: &Section) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Section

impl StructuralPartialEq for Section