Skip to main content

EventDefinition

Struct EventDefinition 

Source
pub struct EventDefinition {
    pub id: &'static str,
    pub label: &'static str,
    pub category: EventCategory,
    pub scope: EventScope,
    pub confidence: DetectionConfidence,
    pub summary: &'static str,
    pub approach: &'static [&'static str],
    pub limitations: &'static [&'static str],
    pub hidden_from_review: bool,
    pub variants: &'static [EventVariant],
}
Expand description

Static, English-language metadata for a stat event type.

Event structs own this definition through StatsEvent. Analysis nodes then link event definitions to the calculator code that produces them via EmittedEvent.

Fields§

§id: &'static str§label: &'static str§category: EventCategory§scope: EventScope

How a timeline client fans this event’s stream out into lanes. Match (the default) keeps everything on one shared row; Team/Player are the opt-in exceptions that split into one lane per team or per player. Declared here so fan-out travels with the event type rather than a side table; the shipped EventMeta.scope reads from this via EventPayload::scope.

§confidence: DetectionConfidence§summary: &'static str§approach: &'static [&'static str]§limitations: &'static [&'static str]§hidden_from_review: bool

When true this definition is a label-like or expansion-parent row that should not be offered as a selectable event type in the review UI.

§variants: &'static [EventVariant]

Concrete event-type keys this definition expands into at serialization time (e.g. boost_ledger -> boost_ledger_collected). Expansion parents are typically also hidden_from_review; their variants are surfaced instead. Empty for ordinary events.

Implementations§

Source§

impl EventDefinition

Source

pub const fn hidden(self, hidden: bool) -> Self

Set whether this definition is hidden from the review picker. Named to double as a define_stats_event! modifier (hidden = true).

Source

pub const fn variants(self, variants: &'static [EventVariant]) -> Self

Attach the concrete variant keys this definition expands into. Named to double as a define_stats_event! modifier (variants = SLICE).

Source

pub const fn scope(self, scope: EventScope) -> Self

Set how this event’s stream fans out into timeline lanes. Named to double as a define_stats_event! modifier (scope = EventScope::Player). The default is EventScope::Match (single shared row); declare Player or Team to opt a stream into per-entity lanes.

Trait Implementations§

Source§

impl Clone for EventDefinition

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for EventDefinition

Source§

impl Debug for EventDefinition

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for EventDefinition

Source§

impl PartialEq for EventDefinition

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for EventDefinition

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for EventDefinition

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.