Struct Changelog 

pub struct Changelog(/* private fields */);

Represents a changelog file.

This uses the keep a changelog format to parse and generate changelogs. There is very limited support for deviation from this format so the changelog should not yet be manually edited.

Implementations

impl Changelog

pub fn new() -> Self

Constructs a new changelog.

pub fn title(&self) -> Option<Text<'_>>

Gets the changelog title.

pub fn description(&self) -> Option<MultilineText<'_>>

Gets the changelog description.

pub fn add_release(&mut self, release: impl Into<Release>) -> &mut Self

Adds a new release to the changelog.

pub fn with_release(self, release: impl Into<Release>) -> Self

Builds the changelog with the given release.

pub fn get_release(&self, version: impl AsRef<str>) -> Option<ReleaseRef<'_>>

Gets a release for the given version.

pub fn releases(&self) -> impl Iterator<Item = ReleaseRef<'_>>

Gets an iterator over the releases.

pub fn references(&self) -> impl Iterator<Item = ReferenceRef<'_>>

Gets an iterator over the references.

Trait Implementations

impl Clone for Changelog

fn clone(&self) -> Changelog

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 Default for Changelog

fn default() -> Self

Returns the “default value” for a type.

impl Display for Changelog

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

Formats the value using the given formatter.

impl Eq for Changelog

impl FromStr for Changelog

type Err = Infallible

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for Changelog

fn eq(&self, other: &Self) -> 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.