Struct RuleId 

pub struct RuleId { /* private fields */ }

A namespaced rule identifier, such as lanekeep/no-default-export.

Construct one by parsing: "local/no-numeric-sizes".parse::<RuleId>().

Implementations

impl RuleId

pub const fn namespace(&self) -> &Namespace

Which namespace this rule belongs to.

pub fn name(&self) -> &str

The name portion, without the namespace or separator.

pub fn is_built_in(&self) -> bool

Whether this is a rule shipped with lanekeep.

pub fn new(namespace: Namespace, name: &str) -> Result<Self, ParseRuleIdError>

Build an ID from parts, validating the name.

Errors

Returns ParseRuleIdError when the name is empty or not in the required form.

pub fn namespace_from_str( namespace: &str, ) -> Result<Namespace, ParseRuleIdError>

A namespace from its written form, validating its shape.

Errors

Returns ParseRuleIdError when it is empty or not lowercase kebab-case.

Trait Implementations

impl Clone for RuleId

fn clone(&self) -> RuleId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RuleId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RuleId

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for RuleId

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

Formats the value using the given formatter.

impl Eq for RuleId

impl FromStr for RuleId

type Err = ParseRuleIdError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for RuleId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for RuleId

Ordering is over the rendered string, not over (Namespace, name).

The distinction matters because violations are sorted by (ruleId, file, line, column) and that order is part of lanekeep’s output contract. Deriving Ord would order by the Namespace enum’s declaration order, so adding a variant — say, one sorting between the existing two — would silently reorder every report without any output-producing code changing. Comparing rendered strings is stable against that, and is also the order a reader expects from looking at the output.

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for RuleId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for RuleId

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for RuleId

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RuleId