Struct DiagnosticCode 

pub struct DiagnosticCode(pub String);

A stable dotted diagnostic code, e.g. EMIT.BMOPF.TRANSFORMER_UNSUPPORTED.

The grammar is NAMESPACE.SCOPE.SPECIFIC: uppercase ASCII letters, digits and _ inside a segment, . between segments, at least three segments. A large scope may use more (EMIT.BMOPF.TRANSFORMER.TAP_COLLAPSED), so a consumer reads the first segment and treats the rest as opaque identity.

The first segment is the namespace and names the stage the finding came from; DiagnosticStage decodes it. A code carried by a document powerio did not write may use a namespace outside the ten, which is data rather than a failure.

Tuple Fields

0: String

Implementations

impl DiagnosticCode

pub fn new(code: impl Into<String>) -> Self

pub fn namespace(&self) -> &str

The leading dotted segment (the namespace), e.g. EMIT for EMIT.PSSE.FIELD_DROPPED.

pub fn stage(&self) -> Option<DiagnosticStage>

The stage this code names, or None when the namespace is outside the ten powerio emits.

pub fn as_str(&self) -> &str

pub fn is_well_formed(&self) -> bool

Whether this code matches the grammar. Nothing refuses a code that does not; the registry gates check it so a new code cannot be minted malformed.

Trait Implementations

impl Clone for DiagnosticCode

fn clone(&self) -> DiagnosticCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DiagnosticCode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DiagnosticCode

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DiagnosticCode

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

Formats the value using the given formatter.

impl Eq for DiagnosticCode

impl From<&str> for DiagnosticCode

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for DiagnosticCode

fn from(s: String) -> Self

Converts to this type from the input type.

impl Hash for DiagnosticCode

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 JsonSchema for DiagnosticCode

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for DiagnosticCode

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for DiagnosticCode

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 DiagnosticCode