Struct Release 

#[non_exhaustive]
pub struct Release {
    pub version: Option<String>,
    pub date: Option<String>,
    pub date_span: Option<Span>,
    pub yanked: bool,
    pub heading: String,
    pub link: Option<String>,
    pub sections: Vec<Section>,
    pub span: Span,
    pub attributes: BTreeMap<String, String>,
    pub links: Vec<LinkDefinition>,
}

A release identifier is opaque: neither SemVer nor chronological sorting is imposed.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

version: Option<String>

Opaque identifier; None represents pending or unversioned content.

date: Option<String>

Optional calendar date. Use validation to check calendar correctness. Timestamp-based formats retain the original timestamp in attributes.

date_span: Option<Span>

Source location of a date stored outside the release heading, if known.

yanked: bool

Whether the source explicitly marks this release as withdrawn.

heading: String

Original heading text, or decoded release title from a structured export.

link: Option<String>

Resolved link on the release heading, if present.

sections: Vec<Section>

Ordered groups, including unnamed groups for uncategorized content.

span: Span

Source location of the release heading.

attributes: BTreeMap<String, String>

Format-specific attributes such as package, bump, author, or timestamp. Empty for ordinary Keep a Changelog releases.

links: Vec<LinkDefinition>

References local to an independently decoded body, overriding document links. Empty for formats whose releases share one Markdown document.

Implementations

impl Release

pub fn new(version: Option<String>) -> Self

Create a release with no date, content, attributes, or source location. A missing identifier starts as pending; attributes can refine its state.

pub fn status(&self) -> ReleaseStatus

Classify this release using its current identifier and format attributes.

use logloom::{Release, ReleaseStatus};
let mut release = Release::new(Some("v1".into()));
assert_eq!(release.status(), ReleaseStatus::Published);
release.attributes.insert("draft".into(), "true".into());
assert_eq!(release.status(), ReleaseStatus::Draft);

pub fn is_published(&self) -> bool

Whether published selectors should include this release or date/author record.

pub fn is_pending(&self) -> bool

Whether this release is pending, including explicitly marked drafts.

pub fn package(&self) -> Option<&str>

Borrow the format’s package name, when present.

pub fn is_prerelease(&self) -> bool

Whether the input explicitly marks this as a prerelease.

Trait Implementations

impl Clone for Release

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Release

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Release

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Release

impl PartialEq for Release

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Release

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Release