Struct ApiEntry 

pub struct ApiEntry {
    pub crate_name: &'static str,
    pub module_path: &'static str,
    pub function_name: &'static str,
    pub signature: &'static str,
    pub description: &'static str,
    pub math_reference: &'static str,
    pub example: &'static str,
    pub see_also: &'static [&'static str],
    pub category: ApiCategory,
}

A documented API entry with mathematical background and usage example.

Fields

crate_name: &'static str

Crate that provides this API (e.g. “scirs2-linalg”)

module_path: &'static str

Module path within the crate (e.g. “decomposition”)

function_name: &'static str

Function or type name (e.g. “svd”)

signature: &'static str

Rust signature (e.g. pub fn svd<F>(...) -> LinalgResult<...>)

description: &'static str

Human-readable description

math_reference: &'static str

Mathematical formula or reference in plain text

example: &'static str

Complete Rust code example (syntactically correct)

see_also: &'static [&'static str]

Related API names for cross-reference

category: ApiCategory

API category

Trait Implementations

impl Clone for ApiEntry

fn clone(&self) -> ApiEntry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiEntry

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

Formats the value using the given formatter.