Struct ChangeLog

pub struct ChangeLog {
    pub scopes: Vec<Scope>,
    pub commits: Vec<Commit>,
    pub remote_url: Option<String>,
    pub range: String,
    pub date: String,
}

A categorized changelog

Fields

scopes: Vec<Scope>

A list of scoped changes in the commit range.

commits: Vec<Commit>

A list of “interesting” commits in the range.

remote_url: Option<String>

The fetch url of the remote (useful for change number links)

range: String

The revision range for commits in this changelog

date: String

The time range for the commits in this changelog

Implementations

impl ChangeLog

pub fn new() -> Self

Generate a new changelog for the default input range

pub fn from_range(range: &str, config: &Configuration) -> Self

Generate a changelog for the given range

pub fn from_log(args: Vec<String>, config: &Configuration) -> Self

Create a changelog from the given git log arguments

pub fn from<T: Iterator<Item = Commit>>( commits: T, config: &Configuration, ) -> Self

Create a changelog from the given commits using the given conventions

Trait Implementations

impl Debug for ChangeLog

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

Formats the value using the given formatter.

impl Default for ChangeLog

fn default() -> ChangeLog

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

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 ChangeLog

impl StructuralPartialEq for ChangeLog