Enum RuleConfigurationError

pub enum RuleConfigurationError {
    UnexpectedProperty(String),
    MissingProperty(String),
    MissingAnyProperty(Vec<String>),
    BooleanExpected(String),
    StringExpected(String),
    UsizeExpected(String),
    FloatExpected(String),
    StringListExpected(String),
    RequireModeExpected(String),
    UnexpectedValueType(String),
    UnexpectedValue {
        property: String,
        message: String,
    },
    PropertyCollision(Vec<String>),
    InternalUsageOnly(String),
}

When implementing the configure method of the Rule trait, the method returns a result that uses this error type.

Variants

UnexpectedProperty(String)

When a rule gets an unknown property. The string should be the unknown field name.

MissingProperty(String)

When a rule has a required property. The string should be the field name.

MissingAnyProperty(Vec<String>)

When a rule must define at least one property in a given set.

BooleanExpected(String)

When a property is associated with something else than an expected boolean. The string is the property name.

StringExpected(String)

When a property is associated with something else than an expected string. The string is the property name.

UsizeExpected(String)

When a property is associated with something else than an expected unsigned number. The string is the property name.

FloatExpected(String)

When a property is associated with something else than an expected float. The string is the property name.

StringListExpected(String)

When a property is associated with something else than an expected list of strings. The string is the property name.

RequireModeExpected(String)

When a property is associated with something else than an expected require mode. The string is the property name.

UnexpectedValueType(String)

When the value type is invalid. The string is the property name that was given the wrong value type.

UnexpectedValue

When the value is invalid.

Fields

property: String

message: String

PropertyCollision(Vec<String>)

When a rule cannot have multiple properties defined at the same time.

InternalUsageOnly(String)

When a rule can only be used internally by darklua. The string is the rule name (this error should not surface to external consumers)

Trait Implementations

impl Clone for RuleConfigurationError

fn clone(&self) -> RuleConfigurationError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RuleConfigurationError

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

Formats the value using the given formatter.

impl Display for RuleConfigurationError

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

Formats the value using the given formatter.

impl PartialEq for RuleConfigurationError

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for RuleConfigurationError

impl StructuralPartialEq for RuleConfigurationError