Struct SignalDef 

pub struct SignalDef {
    pub name: String,
    pub kind: SignalKind,
    pub relationships: Vec<String>,
    pub direction: ReachDirection,
    pub neighbour_field: Option<String>,
    pub neighbour_value: Option<String>,
    pub thresholds: Vec<SignalThreshold>,
}

One declared aggregate signal on a type definition. This wave ships one kind, edge_load: count the edges of a named rel-type set, in a named direction, on entities of this type, optionally restricted to edges whose counterpart entity holds a named enum value. Thresholds map counts to levels; below the first threshold the served level is none. Values are computed at read time in O(degree), never stored, never part of _hash; a signal may not reference another signal, and nothing multiplies, averages, or decays — a count and a threshold are the whole vocabulary.

Fields

name: String

Unique per type, [a-z][a-z0-9_]* — the stable name prose and consumers bind guidance to.

kind: SignalKind

Closed kind enum — one member in this wave.

relationships: Vec<String>

Edge names the count covers (inline relation set; loader validates each against the vocabulary).

direction: ReachDirection

in counts edges pointing at the entity, out edges pointing away — the same vocabulary the store and search speak.

neighbour_field: Option<String>

Optional counterpart filter, whole or not at all: count only edges whose counterpart entity holds neighbour_value in neighbour_field. A counterpart lacking the field or holding another value simply does not count.

neighbour_value: Option<String>

thresholds: Vec<SignalThreshold>

Non-empty, strictly increasing at_least values.

Implementations

impl SignalDef

pub fn level_for(&self, count: u64) -> Option<SignalLevel>

The served level for a count: the highest threshold whose at_least the count meets, None below the first (wire level none).

Trait Implementations

impl Clone for SignalDef

fn clone(&self) -> SignalDef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SignalDef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SignalDef

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for SignalDef

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for SignalDef

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SignalDef

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SignalDef