Struct SignalLabels 

#[non_exhaustive]
pub struct SignalLabels {
    pub workflow: Option<WorkflowKey>,
    pub provider: Option<ProviderKey>,
    pub risk: Option<RiskClass>,
    pub model: Option<ModelKey>,
    pub purpose: Option<String>,
    pub interaction: Option<InteractionKind>,
    pub error_code: Option<String>,
    pub operation: Option<OperationKey>,
    pub effort: Option<Effort>,
}

Structured, text-free labels attached to a signal.

Every field is an identifier or an enumeration with a bounded value set. Observers may drop labels a signal does not document; they must never add free text.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

workflow: Option<WorkflowKey>

Workflow the signal concerns.

provider: Option<ProviderKey>

Provider key, for provider signals.

risk: Option<RiskClass>

Risk class, for command signals.

model: Option<ModelKey>

Model key, for provider signals. Configured model identifiers only.

purpose: Option<String>

Normalized request purpose (e.g. "extract"), for provider signals (spec §20.2).

interaction: Option<InteractionKind>

Interaction kind, for interaction signals.

error_code: Option<String>

Stable machine-readable code that qualifies a failure or rejection (a RejectionCode, a provider failure code, an invariant kind…). Never a message.

operation: Option<OperationKey>

Operation an act names, for signals about one act rather than one turn.

Bounded like Self::workflow is, because the set of operations is the catalog and the catalog is finite. Never an argument or a value.

effort: Option<Effort>

The effort of the turn the signal belongs to.

Implementations

impl SignalLabels

pub fn none() -> Self

No labels.

pub fn workflow(workflow: WorkflowKey) -> Self

Labels with a workflow.

pub fn with_provider(self, provider: impl Into<ProviderKey>) -> Self

Adds a provider key.

pub fn with_risk(self, risk: RiskClass) -> Self

Adds a risk class.

pub fn with_model(self, model: impl Into<ModelKey>) -> Self

Adds a model key.

pub fn with_purpose(self, purpose: impl Into<String>) -> Self

Adds a normalized request purpose.

pub fn with_effort(self, effort: Effort) -> Self

Labels the signal with the turn’s effort.

pub fn with_interaction(self, kind: InteractionKind) -> Self

Adds an interaction kind.

pub fn with_operation(self, operation: impl Into<OperationKey>) -> Self

Adds a stable error or rejection code.

pub fn with_error_code(self, code: impl Into<String>) -> Self

Returns a copy carrying a failure or rejection code.

Trait Implementations

impl Clone for SignalLabels

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 SignalLabels

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

Formats the value using the given formatter.

impl Default for SignalLabels

fn default() -> Self

Returns the “default value” for a type.

impl Eq for SignalLabels

impl PartialEq for SignalLabels

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SignalLabels