Struct RuleId 

pub struct RuleId(/* private fields */);

A bookspec rule identifier: BS-<area>-<n> (e.g. BS-entry-1).

The areas are the specification’s subjects (Area), and n counts from 1 within an area. The catalogue in crate::rules is the list of every identifier the specification states; an identifier that is not in it is a typo, not a rule.

Implementations

impl RuleId

pub fn new(area: Area, n: u32) -> Self

The identifier of area area, rule number n (counting from 1).

pub fn parse(s: &str) -> Result<Self, RuleIdError>

Parse BS-<area>-<n>, refusing an unknown area, a missing or non-numeric number, and a number that is zero or written with a leading zero (one spelling per rule).

pub fn as_str(&self) -> &str

The identifier as the specification writes it.

pub fn area(&self) -> Area

The area it belongs to.

pub fn rule(&self) -> Option<&'static Rule>

The rule’s entry in the catalogue, if the specification states it.

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 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 = RuleIdError

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

fn cmp(&self, other: &RuleId) -> 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: &RuleId) -> 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 StructuralPartialEq for RuleId