Struct ScopeSuggestion 

pub struct ScopeSuggestion {
    pub scope: String,
    pub commits: usize,
    pub directory: String,
    pub ambiguous: bool,
}

Which scope a set of paths belongs to, and the evidence for it.

use majordomus_cli::commit::{ScopeSuggestion, ScopeVocabulary};
let mut v = ScopeVocabulary::default();
// two scopes with equal claim to one directory: reported, never broken silently
v.learn("a", "src", 7);
v.learn("b", "src", 7);
let s: ScopeSuggestion = v.suggest(&["src/x.rs".into()]).expect("a tie");
assert!(s.ambiguous);

Fields

scope: String

The scope.

commits: usize

How many prior commits associate this scope with directories these paths are in.

directory: String

The directory prefix the association was strongest at.

ambiguous: bool

Whether another scope was as strongly associated. A tie is reported rather than broken silently: a planner that guessed would be inventing the one field of a commit message that a reader uses to navigate.

Trait Implementations

impl Clone for ScopeSuggestion

fn clone(&self) -> ScopeSuggestion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScopeSuggestion

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ScopeSuggestion

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ScopeSuggestion

impl JsonSchema for ScopeSuggestion

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for ScopeSuggestion

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ScopeSuggestion