Struct FnEntry 

pub struct FnEntry {
    pub signature: &'static str,
    pub description: &'static str,
    pub example: &'static str,
    pub expected_output: Option<&'static str>,
    pub returns: &'static str,
    pub errors: Option<&'static str>,
    pub see_also: &'static [&'static str],
    pub since: Option<&'static str>,
}

A single stdlib function’s documentation.

Fields

signature: &'static str

The function signature as it appears in rl (e.g. "arr_push(arr, value)").

description: &'static str

What the function does, including edge cases and constraints.

example: &'static str

A runnable rl example showing typical usage.

expected_output: Option<&'static str>

The expected stdout of example, for doctest-style checking. None when the example’s result is shown inline (e.g. as a trailing comment) rather than printed.

returns: &'static str

The return type/value description (e.g. "float", "Result[int]").

errors: Option<&'static str>

When and why this function raises a runtime error. None if the function is infallible.

see_also: &'static [&'static str]

Related function names to cross-link (e.g. ["to_hex", "to_oct"]). Empty if there’s nothing closely related.

since: Option<&'static str>

The version this function was introduced in (e.g. "v0.1.4"). None for functions that predate version tracking.

Trait Implementations

impl Serialize for FnEntry

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

where __S: Serializer,

Serialize this value into the given Serde serializer.