Struct DwCode 

pub struct DwCode { /* private fields */ }

A stable DW diagnostic code together with the exit tier it stops a run at (ExitTier) and whose state its verdict is about (Subject).

A code is not a string that a check happens to quote; it is a rule with its properties, and they travel with it to every site that raises it. Every rule applies to every document the engine accepts (ADR-0024): there is one dsl_version, so a code carries nothing about when it starts binding.

Implementations

impl DwCode

pub const fn new(id: &'static str, tier: ExitTier) -> DwCode

A rule, with the tier it exits at — see ExitTier.

pub const fn about_the_engine(self) -> DwCode

Mark this code an engine-property notice — see Subject::Engine for the test to apply before choosing it. Chained onto the constructor, because the two questions are independent: whose state is it about, and what does it exit with.

pub const fn id(self) -> &'static str

The stable code string (DW0180).

pub const fn exit_tier(self) -> ExitTier

Which exit status a hard failure carrying this code ends the run with.

pub const fn subject(self) -> Subject

Whose state this code’s verdict is about.

Trait Implementations

impl AsRef<str> for DwCode

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for DwCode

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DwCode

impl Debug for DwCode

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

Formats the value using the given formatter.

impl Display for DwCode

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

Formats the value using the given formatter.

impl Eq for DwCode

impl Ord for DwCode

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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for DwCode

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<&str> for DwCode

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<DwCode> for String

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<DwCode> for str

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<DwCode> for &str

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<String> for DwCode

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for DwCode

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 DwCode

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

Serializes as the bare code string: a DwCode in a JSON payload is the &'static str it replaced; the tier and the subject are compiler-internal.

impl StructuralPartialEq for DwCode