Enum Trigger

pub enum Trigger {
    Boolean,
    CompareValue,
    CompareValueWarnEq,
    SetValue,
    CompareDate,
    ItemOrCompareValue(Item),
    Scope(Scopes),
    ScopeOkThis(Scopes),
    Item(Item),
    ScopeOrItem(Scopes, Item),
    Choice(&'static [&'static str]),
    CompareChoice(&'static [&'static str]),
    CompareChoiceOrNumber(&'static [&'static str]),
    Block(&'static [(&'static str, Trigger)]),
    ScopeOrBlock(Scopes, &'static [(&'static str, Trigger)]),
    ItemOrBlock(Item, &'static [(&'static str, Trigger)]),
    CompareValueOrBlock(&'static [(&'static str, Trigger)]),
    ScopeList(Scopes),
    ScopeCompare(Scopes),
    CompareToScope(Scopes),
    Removed(&'static str, &'static str),
    Control,
    Special,
    UncheckedValue,
}

A description of the constraints on the right-hand side of a given trigger. In other words, how it can be used.

It is used recursively in variants like Trigger::Block, where each of the sub fields have their own Trigger.

Variants

Boolean

trigger = no or trigger = yes

CompareValue

can be a script value

CompareValueWarnEq

can be a script value; warn if =

SetValue

can be a script value; no < or >

CompareDate

value must be a valid date

ItemOrCompareValue(Item)

trigger is either = item or compared to another trigger

Scope(Scopes)

trigger is compared to a scope object

ScopeOkThis(Scopes)

trigger is compared to a scope object which may be this

Item(Item)

value is chosen from an item type

ScopeOrItem(Scopes, Item)

Choice(&'static [&'static str])

value is chosen from a list given here

CompareChoice(&'static [&'static str])

value is from a list given here that can be compared

CompareChoiceOrNumber(&'static [&'static str])

like CompareChoice but value can also be just a number

Block(&'static [(&'static str, Trigger)])

For Block, if a field name in the array starts with ? it means that field is optional trigger takes a block with these fields

ScopeOrBlock(Scopes, &'static [(&'static str, Trigger)])

trigger takes a block with these fields

ItemOrBlock(Item, &'static [(&'static str, Trigger)])

trigger takes a block with these fields

CompareValueOrBlock(&'static [(&'static str, Trigger)])

can be part of a scope chain but also a standalone trigger

ScopeList(Scopes)

trigger takes a block of values of this scope type

ScopeCompare(Scopes)

trigger takes a block comparing two scope objects

CompareToScope(Scopes)

this is for inside a Block, where a key is compared to a scope object

Removed(&'static str, &'static str)

Control

this key opens another trigger block

Special

this has specific code for validation

UncheckedValue

Trait Implementations

impl Clone for Trigger

fn clone(&self) -> Trigger

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Trigger

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

Formats the value using the given formatter.

impl PartialEq for Trigger

fn eq(&self, other: &Trigger) -> 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 Copy for Trigger

impl Eq for Trigger

impl StructuralPartialEq for Trigger