Struct Conventions

pub struct Conventions {
    pub scopes: Vec<Keyword>,
    pub categories: Vec<Keyword>,
}

The change categorization conventions used by a repository/project.

Fields

scopes: Vec<Keyword>

The scope keywords

categories: Vec<Keyword>

The category keywords

Implementations

impl Conventions

pub fn scope_title(&self, scope: Option<String>) -> Option<&str>

Get the title for the given scope

pub fn category_title(&self, category: Option<String>) -> Option<&str>

Get the title for the given category

pub fn category_titles(&self) -> Vec<&str>

Get the titles for all the categories defined

pub fn scope_titles(&self) -> Vec<&str>

Get the titles for all the scopes defined

Trait Implementations

impl Debug for Conventions

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

Formats the value using the given formatter.

impl Default for Conventions

fn default() -> Conventions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Conventions

where Conventions: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Conventions

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

impl StructuralPartialEq for Conventions