Struct kcl_lib::docs::StdLibFnArg

pub struct StdLibFnArg {
    pub name: String,
    pub type_: String,
    pub schema: Schema,
    pub required: bool,
}

This struct defines a single argument to a stdlib function.

Fields

name: String

The name of the argument.

type_: String

The type of the argument.

schema: Schema

The schema of the argument.

required: bool

If the argument is required.

Implementations

impl StdLibFnArg

pub fn get_type_string(&self) -> Result<(String, bool)>

pub fn description(&self) -> Option<String>

Trait Implementations

impl Clone for StdLibFnArg

fn clone(&self) -> StdLibFnArg

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StdLibFnArg

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StdLibFnArg

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<StdLibFnArg> for StdLibFnArg

fn eq(&self, other: &StdLibFnArg) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for StdLibFnArg

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StdLibFnArg