Struct BuiltinDef 

pub struct BuiltinDef<H>
where
    H: 'static,
{
    pub sig: BuiltinSignature,
    pub aliases: &'static [&'static str],
    pub handler: H,
    pub category: Option<&'static str>,
    pub doc: Option<&'static str>,
    pub signature_text: Option<&'static str>,
    pub parser_only: bool,
    pub runtime_only: bool,
}

A complete description of one builtin: its signature, its aliases, the runtime handler (typed by the consumer via H), and optional metadata.

H is parametric so this crate stays free of any handler-type dependency. harn-vm instantiates it as BuiltinDef<VmBuiltinHandler>; parser-only consumers ignore the handler and read just the Self::sig field.

Fields

sig: BuiltinSignature

Static signature consumed by the parser/typechecker.

aliases: &'static [&'static str]

Additional names that share this impl + signature. Each alias gets its own BuiltinSignature entry at install time (with the same param/return types) so the typechecker accepts both.

handler: H

Runtime handler (sync fn, async fn, or None for parser-only builtins). Type is opaque to this crate.

category: Option<&'static str>

Free-form category label used for metadata/observability.

doc: Option<&'static str>

Human-readable doc, typically the leading /// block from the impl function. Surfaced to LSP hover and harn explain.

signature_text: Option<&'static str>

Free-form Harn-style signature text (e.g. "foo(a: dict) -> dict"). Populated by #[harn_builtin] from the sig = "..." literal so the runtime metadata layer can surface the original source spelling without re-rendering Self::sig. The DSL builder shape used to store this via .signature(...); the macro shape replaces it.

parser_only: bool

Set to true for builtins that exist in the parser registry but have no runtime entry (len, split, … — see PARSER_ONLY_EXCEPTIONS in the alignment test). The registry skips runtime registration for these.

runtime_only: bool

Set to true for compiler-synthesized runtime helpers (sigil prefix __, opcode keywords, enum constructors) that exist as VM builtins but should NOT show up in the parser signature table. The registry skips signature publishing for these.

Implementations

impl<H> BuiltinDef<H>

where H: 'static,

pub const fn new(sig: BuiltinSignature, handler: H) -> BuiltinDef<H>

Compact constructor for the common case: one signature, no aliases, no metadata flags.

Trait Implementations

impl<H> Clone for BuiltinDef<H>

where H: Clone + 'static,

fn clone(&self) -> BuiltinDef<H>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<H> Debug for BuiltinDef<H>

where H: Debug + 'static,

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

Formats the value using the given formatter.

impl<H> Copy for BuiltinDef<H>

where H: Copy + 'static,