Struct Changelog 

#[non_exhaustive]
pub struct Changelog {
    pub format: Format,
    pub metadata: Metadata,
    pub releases: Vec<Release>,
    pub links: Vec<LinkDefinition>,
    pub source: String,
}

An owned, serializable changelog independent of its source format.

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.

format: Format

Source format, retained so validation uses the correct conventions. Defaults to Keep a Changelog when reading older serialized models.

metadata: Metadata

Title and introductory Markdown.

releases: Vec<Release>

All releases, including pending releases, in original document order.

links: Vec<LinkDefinition>

Document-wide reference definitions in source order. Independently decoded bodies keep their definitions in Release::links.

source: String

Exact input, including whitespace, duplicate definitions, and line endings. Defaults to empty when deserializing CLI exports, which omit this field. Spans still refer to the original input when the source copy is absent.

Implementations

impl Changelog

pub fn new(format: Format) -> Self

Create an empty document of the given format, without source text.

use logloom::{Changelog, Format, Release};
let mut changelog = Changelog::new(Format::GenericMarkdown);
changelog.releases.push(Release::new(Some("preview".into())));
assert_eq!(changelog.releases.len(), 1);

Trait Implementations

impl Clone for Changelog

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 Changelog

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Changelog

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Changelog

impl PartialEq for Changelog

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Changelog

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 Changelog