Enum ContractViolation 

#[non_exhaustive]
pub enum ContractViolation {
    MissingMessage {
        message: String,
    },
    MissingValue {
        message: String,
    },
    MissingAttribute {
        message: String,
        attribute: String,
    },
    UnknownVariable {
        message: String,
        attribute: Option<String>,
        variable: String,
    },
    ElementMismatch {
        message: String,
        expected: Vec<String>,
        found: Vec<String>,
    },
    BoolSelectorMismatch {
        message: String,
        attribute: Option<String>,
        variable: String,
        found: Vec<String>,
    },
    BoolReferenceOutsideSelector {
        message: String,
        attribute: Option<String>,
        variable: String,
    },
    UnknownTerm {
        term: String,
        referenced_from: String,
    },
}

One way an external .ftl failed to satisfy a MessageContract.

Carried by L10nError::Validation. Each variant describes a mistake that would otherwise surface later as a panic or formatting error in a generated accessor.

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.

MissingMessage

A contract message is missing from the .ftl entirely.

Fields

message: String

The message id.

MissingValue

The message exists but has no value of its own, and the contract expects one (the message defines only attributes).

Fields

message: String

The message id.

MissingAttribute

The message exists but lacks a required attribute.

Fields

message: String

The message id.

attribute: String

The missing attribute.

UnknownVariable

The pattern references a variable that is not a contract argument. The generated accessor would leave it unfilled, which fails to format.

Fields

message: String

The message id.

attribute: Option<String>

The attribute, for an attribute accessor.

variable: String

The unknown $variable name.

ElementMismatch

The (Element) marker sequence does not match the contract, so the structured-message split would not produce the expected slots. The entries are rendered as $variable / -term.

Fields

message: String

The message id.

expected: Vec<String>

The contract’s marker sequence.

found: Vec<String>

The sequence found in the .ftl.

BoolSelectorMismatch

A Boolean variable’s selector does not contain exactly [true] and [false] branches.

Fields

message: String

The message id.

attribute: Option<String>

The attribute, for an attribute accessor.

variable: String

The Boolean variable driving the selector.

found: Vec<String>

Variant keys found in the translation.

BoolReferenceOutsideSelector

A Boolean variable is referenced outside its selector, which would render its encoded true / false string directly.

Fields

message: String

The message id.

attribute: Option<String>

The attribute, for an attribute accessor.

variable: String

The Boolean variable referenced directly.

UnknownTerm

A referenced term is not defined in the .ftl. Resolving it would fail to format at runtime.

Fields

term: String

The referenced -term name.

referenced_from: String

Where the reference was found: a message id, message.attribute, or another term rendered as -term.

Trait Implementations

impl Clone for ContractViolation

fn clone(&self) -> ContractViolation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContractViolation

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

Formats the value using the given formatter.

impl Display for ContractViolation

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

Formats the value using the given formatter.

impl Eq for ContractViolation

impl PartialEq for ContractViolation

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ContractViolation