Enum Subject

pub enum Subject {
    ConventionalCommit {
        breaking_change: bool,
        category: Type,
        scope: Option<String>,
        description: String,
    },
    Fixup(String),
    PullRequest {
        id: String,
        description: String,
    },
    Release {
        version: String,
        scope: Option<String>,
        description: String,
    },
    Remove(String),
    Rename(String),
    Revert(String),
    SubtreeCommit {
        operation: SubtreeOperation,
        description: String,
    },
    Simple(String),
}

Classified subject

use subject_classifier::Subject;

let subject = Subject::from("feat: Some new feature");

Variants

ConventionalCommit

Conventaion Commit following the specification

Fields

breaking_change: bool

category: Type

scope: Option<String>

description: String

Fixup(String)

Git fixup commit

PullRequest

A merged pull request

Fields

id: String

description: String

Release

Commit releasing something

Fields

version: String

scope: Option<String>

description: String

Remove(String)

Something removed

Rename(String)

Something renamed

Revert(String)

Commit created by git-revert

SubtreeCommit

A commit modifying a subtree tracked bygit-stree.

Fields

operation: SubtreeOperation

description: String

Simple(String)

Just some commit

Implementations

impl Subject

pub const fn icon(&self) -> &str

Return a unicode character representing the subject

pub fn description(&self) -> &str

Manipulated commit subject

pub const fn scope(&self) -> Option<&String>

Returns the scope defined by e.g. Conventional Commit

Trait Implementations

impl Clone for Subject

fn clone(&self) -> Subject

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Subject

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

Formats the value using the given formatter.

impl From<&str> for Subject

fn from(subject: &str) -> Self

Converts to this type from the input type.

impl PartialEq for Subject

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

impl StructuralPartialEq for Subject