Enum WorkshopError 

#[non_exhaustive]
pub enum WorkshopError {
    Catalog(CatalogError),
    Unknown {
        kind: &'static str,
        spelling: String,
        locale: Locale,
        span: Option<Span>,
    },
    UnknownWithCandidates {
        kind: &'static str,
        spelling: String,
        locale: Locale,
        candidates: Vec<String>,
        span: Option<Span>,
    },
    NotDetected {
        kind: &'static str,
        message: String,
        span: Option<Span>,
    },
    MissingMapping {
        kind: &'static str,
        id: String,
        locale: Locale,
    },
    Malformed {
        message: String,
        span: Option<Span>,
    },
    Unsupported {
        message: String,
        span: Option<Span>,
    },
}

A structured Workshop-language error.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Catalog(CatalogError)

Catalog data is malformed or fails validation.

Unknown

A localized spelling is unknown or ambiguous.

Fields

kind: &'static str

spelling: String

locale: Locale

span: Option<Span>

UnknownWithCandidates

A localized spelling is unknown or ambiguous, and the rejecting site attached its nearest accepted spellings.

This is a separate variant from WorkshopError::Unknown so the candidate list does not change that variant’s shape; consumers matching Unknown should also match this variant to handle every unknown-spelling diagnostic. The rendered message names the candidates, so they reach consumers that only see the message text.

Fields

kind: &'static str

spelling: String

locale: Locale

candidates: Vec<String>

The nearest accepted spellings for spelling in the rejecting site’s accepted space; empty when nothing was close.

span: Option<Span>

NotDetected

Detection found no usable evidence in the input, so nothing was resolved and no spelling was rejected.

This is a separate variant from WorkshopError::Unknown: Unknown reports a rejected spelling under a resolved locale, while a zero-evidence detection has no rejected spelling to name and no selected locale — naming the detection ranking’s first candidate would report an arbitrary ordering tiebreak as if it were evidence. Consumers matching Unknown do not see this variant, which is how they tell a nameless detection failure from a genuine rejection.

Fields

kind: &'static str

message: String

What evidence was missing and how to supply it explicitly.

span: Option<Span>

MissingMapping

A canonical builtin has no spelling mapped for the target locale.

Missing target-locale mappings fail explicitly (never a guess, never a silent passthrough of another locale’s spelling); fallback is opt-in (crate::emitter::EmitOptions, crate::convert::ConvertOptions).

Fields

kind: &'static str

id: String

locale: Locale

Malformed

The input is syntactically malformed.

Fields

message: String

span: Option<Span>

Unsupported

A construct is recognized but outside the supported surface.

Fields

message: String

span: Option<Span>

Implementations

impl WorkshopError

pub fn malformed(message: impl Into<String>, span: Option<Span>) -> Self

A Malformed error.

pub fn unknown( kind: &'static str, spelling: impl Into<String>, locale: Locale, span: Option<Span>, ) -> Self

An Unknown spelling error.

pub fn not_detected( kind: &'static str, message: impl Into<String>, span: Option<Span>, ) -> Self

A NotDetected detection-failure error.

pub fn with_candidates(self, candidates: Vec<String>) -> Self

Attach the nearest accepted spellings to an Unknown diagnostic, producing WorkshopError::UnknownWithCandidates. Calling this on a candidate-carrying error replaces the list; other variants are returned unchanged.

pub fn candidates(&self) -> &[String]

The nearest accepted spellings for an Unknown spelling, when the rejecting site computed them. Other variants report an empty slice.

pub fn unsupported(message: impl Into<String>, span: Option<Span>) -> Self

An Unsupported construct error.

pub fn span(&self) -> Option<Span>

The source span attached to this error, when recorded.

Trait Implementations

impl Clone for WorkshopError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkshopError

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

Formats the value using the given formatter.

impl Display for WorkshopError

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

Formats the value using the given formatter.

impl Eq for WorkshopError

impl PartialEq for WorkshopError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for WorkshopError