Enum RhetoricalCategory 

pub enum RhetoricalCategory {
    Removal,
    Addition,
    Modification,
    Other,
}

Rhetorical classification of an event based on its template key.

Used by DocumentPlan::from_events_grouped to organize a batch of events into thematic sections — a breaking-changes paragraph, an additions paragraph, etc. — instead of the default same-entity grouping.

Variants

Removal

Deletions, removals — typically breaking changes. Leads the narrative.

Addition

New entities, features, introductions.

Modification

Modifications, renames, moves, signature changes — existing code that was altered.

Other

Anything the default classifier doesn’t recognize.

Trait Implementations

impl Clone for RhetoricalCategory

fn clone(&self) -> RhetoricalCategory

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RhetoricalCategory

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

Formats the value using the given formatter.

impl Hash for RhetoricalCategory

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 Ord for RhetoricalCategory

fn cmp(&self, other: &RhetoricalCategory) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for RhetoricalCategory

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

fn partial_cmp(&self, other: &RhetoricalCategory) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for RhetoricalCategory

impl Eq for RhetoricalCategory

impl StructuralPartialEq for RhetoricalCategory