Struct Change

pub struct Change {
    pub unique_id: UniqueId,
    pub versioning: Versioning,
    pub summary: String,
}

Represents a single change which is applicable to any number of packages.

Fields

unique_id: UniqueId

Something to uniquely identify a change.

This is the name of the file (without the .md extension) which defines this changeset.

versioning: Versioning

Describes how a changeset affects the relevant packages.

summary: String

The details of the change which will be written to a Changelog file

Implementations

impl Change

pub fn write_to_directory<T: AsRef<Path>>(&self, path: T) -> Result<PathBuf>

Create a markdown file in the provided directory with the contents of this Change.

The name of the created file will be the Change::unique_id with the .md extension— that path is returned.

Errors

If the file cannot be written, an std::io::Error is returned. This may happen if the directory does not exist.

pub fn from_file<T: AsRef<Path>>(path: T) -> Result<Self, LoadingError>

Load a Change from a Markdown file.

Errors

• If the file can’t be read
• If the file doesn’t have a valid name (it doesn’t end in .md)
• If the file doesn’t have a valid front matter
• If the file doesn’t have valid versioning info in the front matter

pub fn from_file_name_and_content( file_name: &str, content: &str, ) -> Result<Self, LoadingError>

Given the name of a file and its content, create a Change.

Errors

• If the file doesn’t have a valid name (it doesn’t end in .md)
• If the file doesn’t have a valid front matter
• If the file doesn’t have valid versioning info in the front matter

Trait Implementations

impl Clone for Change

fn clone(&self) -> Change

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Change

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

Formats the value using the given formatter.

impl Display for Change

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

Formats the value using the given formatter.

impl FromIterator<Change> for ChangeSet

fn from_iter<T: IntoIterator<Item = Change>>(iter: T) -> Self

Creates a value from an iterator.

impl PartialEq for Change

fn eq(&self, other: &Change) -> 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 Eq for Change

impl StructuralPartialEq for Change