Struct Code 

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

A stable diagnostic code, rendered as Y####.

use oneyaml_core::code::{self, CodeRange};
use oneyaml_core::{Code, Severity};

let c = Code::parse("Y1014").unwrap();
assert_eq!(c, code::DUPLICATE_KEY_LAST_WINS);
assert_eq!((c.get(), c.to_string()), (1014, "Y1014".to_owned()));
assert_eq!(c.range(), CodeRange::Schema);
assert_eq!(CodeRange::Schema.bounds(), (1000, 1999));
let info = c.info().unwrap(); // the registry entry
assert_eq!(info.name, "DUPLICATE_KEY_LAST_WINS");
assert_eq!(info.severity, Severity::Warning);
assert!(Code::parse("Y0000").is_none()); // Y0000 is never used
assert_eq!(format!("{c:?}"), "Y1014"); // `Debug` shows the same form

Implementations

impl Code

pub const fn new(n: u16) -> Option<Self>

Returns the code with number n, or None if n lies outside every allocated range (including 0).

This validates the range only and exists for parsing, deserializing, and tests. Library code never calls it: it emits only the registered constants in this module, which a test enforces by scanning the library crates’ sources.

pub const fn get(self) -> u16

The numeric value.

pub const fn range(self) -> CodeRange

The range this code belongs to.

pub fn parse(s: &str) -> Option<Self>

Parses the Y#### form (exactly four digits).

pub fn info(self) -> Option<&'static CodeInfo>

The registry entry for this code, if it is allocated.

Trait Implementations

impl Clone for Code

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 Code

impl Debug for Code

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

Formats the value using the given formatter.

impl Display for Code

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

Formats the value using the given formatter.

impl Eq for Code

impl Hash for Code

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 Code

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 Code

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Code

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 StructuralPartialEq for Code