Struct ChangelogEdit 

pub(crate) struct ChangelogEdit {
    path: RepositoryPath,
    before: Option<Vec<u8>>,
    contents: String,
}

A unit changelog read from the repository, with the edit that adds a release entry to it.

Fields

path: RepositoryPath

before: Option<Vec<u8>>

contents: String

Implementations

impl ChangelogEdit

pub(crate) fn read( root: &RepositoryRoot, path: &RepositoryPath, ) -> Result<Self, ReadError>

Read the changelog at path. An absent file reads as an empty changelog.

pub(crate) fn render( &self, version: &str, date: &str, entry: &Entry, ) -> Result<Self, MissingUnreleased>

This changelog with the entry for version above its Unreleased content.

Errors

Returns an error when the changelog has no Unreleased heading.

pub(crate) fn contribute( &self, edits: &mut PlannedEdits, ) -> Result<(), EditError>

Add this changelog as an edit.

Errors

Returns an error when the edit conflicts with another one.

Trait Implementations

impl Clone for ChangelogEdit

fn clone(&self) -> ChangelogEdit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChangelogEdit

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

Formats the value using the given formatter.

impl Eq for ChangelogEdit

impl PartialEq for ChangelogEdit

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ChangelogEdit