Struct Changeset 

pub struct Changeset {
    pub id: String,
    pub summary: String,
    pub packages: Vec<PackageChange>,
    pub description: Option<String>,
}

A changeset describing pending changes for a release.

Fields

id: String

Unique identifier for this changeset.

summary: String

Summary of the change (first line, used as title).

packages: Vec<PackageChange>

Packages affected by this change.

description: Option<String>

Optional longer description.

Implementations

impl Changeset

pub fn new( summary: impl Into<String>, packages: Vec<PackageChange>, description: Option<String>, ) -> Self

Create a new changeset with a generated ID.

pub fn with_id( id: impl Into<String>, summary: impl Into<String>, packages: Vec<PackageChange>, description: Option<String>, ) -> Self

Create a changeset with a specific ID.

pub fn parse(content: &str, id: &str) -> Result<Self>

Parse a changeset from its Markdown content.

Errors

Returns an error if the content is not valid changeset format.

pub fn to_markdown(&self) -> String

Convert the changeset to Markdown format.

pub fn filename(&self) -> String

Get the filename for this changeset.

Trait Implementations

impl Clone for Changeset

fn clone(&self) -> Changeset

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Changeset

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Changeset

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Changeset

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

impl Serialize for Changeset

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Changeset

impl StructuralPartialEq for Changeset