Struct ReleaseNote 

pub struct ReleaseNote { /* private fields */ }

What one version brought, for a ReleaseNotes.

Implementations

impl ReleaseNote

pub fn new(version: impl Into<String>, title: impl Into<String>) -> Self

A note on version, as the app words it, with the title of the release.

pub fn date(self, date: impl Into<String>) -> Self

The release date, already formatted.

pub fn changes( self, changes: impl IntoIterator<Item = impl Into<String>>, ) -> Self

The list of what changed.

pub fn section( self, heading: impl Into<String>, text: impl Into<String>, ) -> Self

Adds a block of text with a heading, after what is already there.

pub fn code(self, code: impl Into<String>) -> Self

Adds a CodeBlock, after what is already there.

pub fn links<F: Fn() + 'static>( self, heading: impl Into<String>, links: impl IntoIterator<Item = (impl Into<String>, F)>, ) -> Self

Adds a heading over links, after what is already there: each a label and what clicking it does, such as opening the issue a change came from.

pub fn badge(self, label: impl Into<String>, tone: Tone) -> Self

Marks the version, such as “Installed” or “New”.

Trait Implementations

impl Clone for ReleaseNote

fn clone(&self) -> ReleaseNote

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReleaseNote

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

Formats the value using the given formatter.