Enum LookupMatch 

#[non_exhaustive]
pub enum LookupMatch {
    Builtin {
        kind: Kind,
        id: String,
        display_name: Option<String>,
        signature: Option<Signature>,
    },
    EnumMember {
        domain: String,
        member: String,
        display_name: Option<String>,
    },
    EnumDomain {
        domain: String,
        display_name: Option<String>,
        members: Vec<LookupEnumMember>,
    },
    Setting {
        definition: SettingDefinition,
        display_name: String,
    },
    Parameter {
        callable: String,
        position: usize,
        required: bool,
        param: SignatureParam,
        domain: Option<SignatureDomain>,
    },
    SettingPath {
        path: String,
        segment: String,
    },
}

One canonical construct matching a Catalog::lookup query.

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.

Builtin

A catalog builtin: structural keyword, action, value, event, or operator.

Fields

kind: Kind

The entry’s catalog kind.

id: String

The canonical identity (createHudText, global).

display_name: Option<String>

The display name in the requested locale, when mapped.

signature: Option<Signature>

The call signature, for actions and values.

EnumMember

A member of a canonical enum domain (Team.ALL, Hero.SOLDIER_76).

Fields

domain: String

The canonical domain name.

member: String

The canonical member id.

display_name: Option<String>

The member’s display name in the requested locale, when mapped.

EnumDomain

A canonical enum domain and the members it accepts.

Fields

domain: String

The canonical domain name.

display_name: Option<String>

The domain’s display name in the requested locale, when mapped.

members: Vec<LookupEnumMember>

Every member the domain accepts.

Setting

A reviewed settings-table definition: a valid key with its path, kind, and value forms.

Fields

definition: SettingDefinition

The canonical semantic definition.

display_name: String

The display name in the requested locale, or the English name when the locale has no mapping.

Parameter

A parameter of a scoped callable, in call order. Returned only by Catalog::lookup_within; an unscoped Catalog::lookup never answers parameters.

Fields

callable: String

The callable’s canonical id.

position: usize

The parameter’s position in call order.

required: bool

Whether the position must be supplied.

param: SignatureParam

The parameter facts: name, declared type, domain, and default.

domain: Option<SignatureDomain>

The enum domain this parameter accepts, with the members it accepts, when the parameter is enum-typed.

SettingPath

The next path segment below a scoped settings prefix — an intermediate selector such as <team> or general, not a leaf key. Returned only by Catalog::lookup_within.

Fields

path: String

The full child path under the scoped prefix (heroes.<team>).

segment: String

The segment text (<team>, general).

Trait Implementations

impl Clone for LookupMatch

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 LookupMatch

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

Formats the value using the given formatter.

impl PartialEq for LookupMatch

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LookupMatch