Struct BuiltinFn 

pub struct BuiltinFn {
    pub name: &'static str,
    pub params: &'static [BuiltinParam],
    pub ret: &'static str,
    pub doc: &'static str,
}

One Lumen script builtin: its name, parameters, return type, and a one-line documentation string.

Fields

name: &'static str

Function name as called from script.

params: &'static [BuiltinParam]

Ordered parameter list.

ret: &'static str

Return type (() for commands that return nothing).

doc: &'static str

One-line summary shown in completion detail and hover.

Implementations

impl BuiltinFn

pub fn signature(&self) -> String

Render a human-readable signature, e.g. set_timeout(name: string, ms: int) -> ().

pub fn snippet(&self) -> String

Render an LSP snippet insert string with tab-stops for each parameter, e.g. set_timeout(${1:name}, ${2:ms}).

pub fn hover_markdown(&self, lang: &str) -> String

Render markdown documentation for hover: a fenced signature line followed by the doc summary.

lang is the fence language, so each host labels its own buffers with its language name.

Trait Implementations

impl Clone for BuiltinFn

fn clone(&self) -> BuiltinFn

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BuiltinFn

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

Formats the value using the given formatter.

impl PartialEq for BuiltinFn

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

impl Eq for BuiltinFn

impl StructuralPartialEq for BuiltinFn