Struct unclog::Release

pub struct Release {
    pub id: String,
    pub version: Version,
    pub maybe_date: Option<NaiveDate>,
    pub changes: ChangeSet,
}

The changes associated with a specific release.

Fields

id: String

This release’s ID (could be the version plus a prefix, e.g. v0.1.0).

version: Version

This release’s version (using semantic versioning).

maybe_date: Option<NaiveDate>

This possibly a release date, parsed according to the configuration file rules.

changes: ChangeSet

The changes associated with this release.

Implementations

impl Release

pub fn read_from_dir<P>(config: &Config, path: P) -> Result<Self>

where P: AsRef<Path>,

Attempt to read a single release from the given directory.

pub fn render(&self, config: &Config) -> String

Attempt to render this release to a string using the given configuration.

Trait Implementations

impl Clone for Release

fn clone(&self) -> Release

Returns a copy 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 Hash for Release

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Release

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Release

impl StructuralPartialEq for Release