Struct StdlibMetadata 

pub struct StdlibMetadata {
    pub effects: Option<Vec<String>>,
    pub allocation: Option<String>,
    pub errors: Option<Vec<String>>,
    pub api_stability: Option<String>,
    pub example: Option<String>,
}

One declared metadata field on a stdlib function. Empty lists and missing fields are distinct: effects: Some(vec![]) records an explicit [] declaration (“statically certified pure”), while effects: None means the author has not annotated the function yet.

serde::Serialize is derived so the same struct can ride through harn graph --json and other JSON wire formats without a parallel type definition.

Fields

effects: Option<Vec<String>>

Declared effect classes (e.g. fs.read, stdio.write, llm.call). Comparable to dependency types in harn graph --json.

allocation: Option<String>

Allocation behavior. The free-form string is intentionally not constrained here so authors can use whichever vocabulary fits the function (e.g. stack-only, heap, caller-owned).

errors: Option<Vec<String>>

Declared error variants the function may return or raise.

api_stability: Option<String>

API stability promise (e.g. stable, experimental, deprecated).

example: Option<String>

Verbatim usage example. Can span multiple lines.

Implementations

impl StdlibMetadata

pub fn is_complete(&self) -> bool

True when every required field has been populated.

pub fn is_empty(&self) -> bool

True when no field has been declared. Used by lints and harn graph --json to distinguish “absent” from “partial”.

pub fn missing_fields(&self) -> Vec<&'static str>

Names of every metadata field that has not been declared.

pub fn to_markdown(&self) -> String

Render the metadata as a markdown block for LSP hover and docs. Only declared fields are emitted; an unannotated function returns an empty string.

Trait Implementations

impl Clone for StdlibMetadata

fn clone(&self) -> StdlibMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StdlibMetadata

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

Formats the value using the given formatter.

impl Default for StdlibMetadata

fn default() -> StdlibMetadata

Returns the “default value” for a type.

impl PartialEq for StdlibMetadata

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for StdlibMetadata

impl StructuralPartialEq for StdlibMetadata