Trait kcl_lib::docs::StdLibFn

pub trait StdLibFn: Debug + Send + Sync {
    // Required methods
    fn name(&self) -> String;
    fn summary(&self) -> String;
    fn description(&self) -> String;
    fn tags(&self) -> Vec<String>;
    fn args(&self) -> Vec<StdLibFnArg>;
    fn return_value(&self) -> Option<StdLibFnArg>;
    fn unpublished(&self) -> bool;
    fn deprecated(&self) -> bool;
    fn examples(&self) -> Vec<String>;
    fn std_lib_fn(&self) -> StdFn;
    fn clone_box(&self) -> Box<dyn StdLibFn>;

    // Provided methods
    fn to_json(&self) -> Result<StdLibFnData> { ... }
    fn fn_signature(&self) -> String { ... }
    fn to_completion_item(&self) -> CompletionItem { ... }
    fn to_signature_help(&self) -> SignatureHelp { ... }
}

This trait defines functions called upon stdlib functions to generate documentation for them.

Required Methods

fn name(&self) -> String

The name of the function.

fn summary(&self) -> String

The summary of the function.

fn description(&self) -> String

The description of the function.

fn tags(&self) -> Vec<String>

The tags of the function.

fn args(&self) -> Vec<StdLibFnArg>

The args of the function.

fn return_value(&self) -> Option<StdLibFnArg>

The return value of the function.

fn unpublished(&self) -> bool

If the function is unpublished.

fn deprecated(&self) -> bool

If the function is deprecated.

fn examples(&self) -> Vec<String>

Any example code blocks.

fn std_lib_fn(&self) -> StdFn

The function itself.

fn clone_box(&self) -> Box<dyn StdLibFn>

Helper function to clone the boxed trait object.

Provided Methods

fn to_json(&self) -> Result<StdLibFnData>

Return a JSON struct representing the function.

fn fn_signature(&self) -> String

fn to_completion_item(&self) -> CompletionItem

fn to_signature_help(&self) -> SignatureHelp

Trait Implementations

impl Clone for Box<dyn StdLibFn>

fn clone(&self) -> Box<dyn StdLibFn>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'de> Deserialize<'de> for Box<dyn StdLibFn>

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl JsonSchema for dyn StdLibFn

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

impl Serialize for Box<dyn StdLibFn>

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl TS for dyn StdLibFn

const EXPORT_TO: Option<&'static str> = _

fn name() -> String

Name of this type in TypeScript.

fn dependencies() -> Vec<Dependency>

where Self: 'static,

Information about types this type depends on. This is used for resolving imports when exporting to a file.

fn transparent() -> bool

true if this is a transparent type, e.g tuples or a list.
This is used for resolving imports when using the export! macro.

fn decl() -> String

Declaration of this type, e.g. interface User { user_id: number, ... }. This function will panic if the type has no declaration.

fn name_with_type_args(args: Vec<String>) -> String

Name of this type in TypeScript, with type arguments.

fn inline() -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened() -> String

Flatten an type declaration.
This function will panic if the type cannot be flattened.

fn export() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to a file. The output file can be specified by annotating the type with #[ts(export_to = ".."]. By default, the filename will be derived from the types name.

fn export_to(path: impl AsRef<Path>) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to a file with a file with the specified path. This function will ignore the #[ts(export_to = "..)] attribute.

fn export_to_string() -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String.
This function does not format the output, even if the format feature is enabled.

Implementors