Struct Convention 

pub struct Convention {
    pub repo: String,
    pub dimension: String,
    pub key: String,
    pub rule: String,
    pub generic: String,
    pub support: usize,
    pub total: usize,
    pub unit: String,
    pub repos: Vec<String>,
    pub exemplars: Vec<String>,
    pub counterexamples: Vec<String>,
    pub origin: Origin,
}

Fields

repo: String

Repo the convention holds in, or ORG for the org baseline.

dimension: String

naming, signatures, models, errors, layout, logging, config, libraries, testing.

key: String

Stable identity of the measured choice, shared across repos (naming:functions:snake_case).

rule: String

generic: String

The rule without repo-specific counts, names or paths (used for the org baseline).

support: usize

total: usize

unit: String

What support and total count, e.g. functions with parameters.

repos: Vec<String>

Org baseline only: the repositories that share it.

exemplars: Vec<String>

path:line of representative, central instances.

counterexamples: Vec<String>

path:line of instances that deviate.

origin: Origin

Implementations

impl Convention

pub fn id(&self) -> String

Stable handle for edits: a manual entry’s id, or a hash of repo and key.

impl Convention

pub fn strength(&self) -> Option<&'static str>

How strictly the code follows it: Always, Usually, Often or Sometimes; None when nothing was counted (the team’s own).

pub fn few(&self) -> bool

Too few instances to call it settled.

pub fn evidence(&self) -> Option<String>

What it was measured from, e.g. Followed by 412 of the 530 functions with parameters.

Trait Implementations

impl Clone for Convention

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Convention

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Convention

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Convention

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Convention

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 Convention