Struct ChangeLog 

pub struct ChangeLog(/* private fields */);

A node in the changelog syntax tree.

Implementations

impl ChangeLog

pub fn line(&self) -> usize

Get the line number (0-indexed) where this node starts.

pub fn column(&self) -> usize

Get the column number (0-indexed, in bytes) where this node starts.

pub fn line_col(&self) -> (usize, usize)

Get both line and column (0-indexed) where this node starts. Returns (line, column) where column is measured in bytes from the start of the line.

impl ChangeLog

pub fn new() -> ChangeLog

Create a new, empty changelog.

pub fn parse(text: &str) -> Parse<ChangeLog>

Parse changelog text, returning a Parse result

pub fn iter(&self) -> impl Iterator<Item = Entry> + '_

Returns an iterator over all entries in the changelog file.

pub fn entries(&self) -> impl Iterator<Item = Entry> + '_

👎Deprecated since 0.2.0: use iter instead

Returns an iterator over all entries in the changelog file.

pub fn new_empty_entry(&mut self) -> EntryBuilder

Create a new, empty entry.

pub fn new_entry(&mut self) -> EntryBuilder

Return a builder for a new entry.

pub fn try_auto_add_change( &mut self, change: &[&str], author: (String, String), datetime: Option<impl IntoTimestamp>, urgency: Option<Urgency>, ) -> Result<Entry, Error>

Add a change to the changelog.

This will update the current changelog entry if it is considered unreleased. Otherwise, a new entry will be created.

If there is an existing entry, the change will be added to the end of the entry. If the previous change was attributed to another author, a new section line (“[ Author Name ]”) will be added as well.

Arguments

• change - The change to add, e.g. &[“* Fix a bug”]
• author - The author of the change, e.g. (“John Doe”, “john@example”)

Errors

Returns an error if text rewrapping fails.

pub fn auto_add_change( &mut self, change: &[&str], author: (String, String), datetime: Option<DateTime<FixedOffset>>, urgency: Option<Urgency>, ) -> Entry

👎Deprecated since 0.2.10: Use try_auto_add_change for proper error handling

Automatically add a change to the changelog

If there is an existing entry, the change will be added to the end of the entry. If the previous change was attributed to another author, a new section line (“[ Author Name ]”) will be added as well.

Deprecated

This function panics on errors. Use ChangeLog::try_auto_add_change instead for proper error handling.

Panics

Panics if text rewrapping fails.

Arguments

• change - The change to add, e.g. &[“* Fix a bug”]
• author - The author of the change, e.g. (“John Doe”, “john@example”)

pub fn pop_first(&mut self) -> Option<Entry>

Pop the first entry from the changelog.

pub fn read_path(path: impl AsRef<Path>) -> Result<ChangeLog, Error>

Read a changelog file from a path

pub fn read<R: Read>(r: R) -> Result<ChangeLog, Error>

Read a changelog file from a reader

pub fn read_relaxed<R: Read>(r: R) -> Result<ChangeLog, Error>

Read a changelog file from a reader, allowing for syntax errors

pub fn write<W: Write>(&self, w: W) -> Result<(), Error>

Write the changelog to a writer

pub fn write_to_path(&self, p: &Path) -> Result<(), Error>

Write the changelog to a path

pub fn iter_by_author( &self, ) -> impl Iterator<Item = (String, String, Vec<Entry>)> + '_

Iterator over entries grouped by their maintainer (author).

Returns an iterator over tuples of (maintainer_name, maintainer_email, Vec) where entries with the same maintainer are grouped together.

pub fn get_all_authors(&self) -> HashSet<Identity>

Get all unique authors across all entries in the changelog.

This includes both maintainers from entry footers and authors from [ Author Name ] sections.

Trait Implementations

impl AstNode for ChangeLog

type Language = Lang

fn can_cast(kind: SyntaxKind) -> bool

fn cast(syntax: SyntaxNode<Lang>) -> Option<Self>

fn syntax(&self) -> &SyntaxNode<Lang>

fn clone_for_update(&self) -> Self

where Self: Sized,

fn clone_subtree(&self) -> Self

where Self: Sized,

impl Clone for ChangeLog

fn clone(&self) -> ChangeLog

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChangeLog

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

Formats the value using the given formatter.

impl Default for ChangeLog

fn default() -> Self

Returns the “default value” for a type.

impl Display for ChangeLog

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

Formats the value using the given formatter.

impl FromIterator<Entry> for ChangeLog

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

Creates a value from an iterator.

impl FromStr for ChangeLog

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for ChangeLog

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 IntoIterator for ChangeLog

type Item = Entry

The type of the elements being iterated over.

type IntoIter = IntoIter<Entry>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for ChangeLog

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

impl StructuralPartialEq for ChangeLog