Struct HintMetadata 

pub struct HintMetadata {
    pub kind: Symbol,
    pub title: String,
    pub detail: Option<String>,
    pub tags: Vec<Symbol>,
    pub arguments: Vec<Symbol>,
    pub capabilities: Vec<CapabilityName>,
    pub codec_forms: Vec<Symbol>,
    pub examples: Vec<String>,
}

Open metadata that helps tools explain or route a diagnostic or operation.

The kind symbol is intentionally open. The remaining fields are common slots used by shape checkers, runtime libraries, and agent-facing indexes to expose expected inputs, argument names, capability requirements, examples, and codec-safe surface forms without adding closed kernel enums.

Fields

kind: Symbol

Open symbol naming the hint kind.

title: String

Short human-readable title.

detail: Option<String>

Optional longer detail text.

tags: Vec<Symbol>

Searchable open tags.

arguments: Vec<Symbol>

Argument names or positions the hint describes.

capabilities: Vec<CapabilityName>

Capabilities required to follow the hint.

codec_forms: Vec<Symbol>

Codec-safe forms related to this hint.

examples: Vec<String>

Short examples a tool can show or index.

Implementations

impl HintMetadata

pub fn new(kind: Symbol, title: impl Into<String>) -> Self

Builds a hint with a kind and title.

pub fn with_detail(self, detail: impl Into<String>) -> Self

Adds longer detail text.

pub fn with_tag(self, tag: Symbol) -> Self

Adds a searchable tag.

pub fn with_argument(self, argument: Symbol) -> Self

Adds an argument name or position.

pub fn with_capability(self, capability: CapabilityName) -> Self

Adds a capability requirement.

pub fn with_codec_form(self, form: Symbol) -> Self

Adds a codec-safe form tag.

pub fn with_example(self, example: impl Into<String>) -> Self

Adds a short example.

pub fn attach_to(self, diagnostic: Diagnostic) -> Diagnostic

Appends this hint to a diagnostic as a related metadata carrier.

pub fn to_diagnostic(&self) -> Diagnostic

Converts this hint into a related diagnostic carrier.

pub fn from_diagnostic(diagnostic: &Diagnostic) -> Option<Self>

Reconstructs hint metadata from a related diagnostic carrier.

pub fn is_hint_diagnostic(diagnostic: &Diagnostic) -> bool

Returns whether a diagnostic is a hint metadata carrier.

pub fn collect_from_diagnostic(diagnostic: &Diagnostic) -> Vec<Self>

Collects the direct hint carriers attached to a diagnostic.

pub fn radar_text(&self) -> String

Builds a text field suitable for simple agent or Radar-style indexing.

pub fn as_value(&self, cx: &mut Cx) -> Result<Value>

Projects the hint as a runtime table value.

pub fn as_datum(&self) -> Datum

Projects the hint as a datum node.

Trait Implementations

impl Clone for HintMetadata

fn clone(&self) -> HintMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HintMetadata

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

Formats the value using the given formatter.

impl Eq for HintMetadata

impl PartialEq for HintMetadata

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