Enum subject_classifier::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

Fields

breaking_change: bool

category: Type

scope: Option<String>

description: String

Conventaion Commit following the specification

Fixup(String)

Git fixup commit

PullRequest

Fields

id: String

description: String

A merged pull request

Release

Fields

version: String

scope: Option<String>

description: String

Commit releasing something

Remove(String)

Something removed

Rename(String)

Something renamed

Revert(String)

Commit created by git-revert

SubtreeCommit

Fields

operation: SubtreeOperation

description: String

A commit modifying a subtree tracked bygit-stree.

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 fn scope(&self) -> Option<String>

Returns the scope defined by e.g. Conventional Commit

Trait Implementations

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

Performs the conversion.

impl PartialEq<Subject> for Subject

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for Subject

impl StructuralEq for Subject

impl StructuralPartialEq for Subject