Struct FunctionDecl 

pub struct FunctionDecl {
    pub name: String,
    pub signature: Option<String>,
    pub params: Vec<String>,
    pub summary: String,
}

A function the host application provides (a jlens_core::HostFunction), declared to the language service so that it is completed and documented like a built-in function.

It deserializes from {"name", "signature", "params", "summary"}; all but name are optional.

Fields

name: String

The name, without the leading $.

signature: Option<String>

The signature, such as <n-n?:n>.

params: Vec<String>

Parameter names, without $, shown by signature help.

summary: String

One-line description.

Implementations

impl FunctionDecl

pub fn new(name: impl Into<String>, summary: impl Into<String>) -> Self

A declaration with a name and a summary.

pub fn signature(self, signature: impl Into<String>) -> Self

Sets the signature.

pub fn params<S: Into<String>>( self, params: impl IntoIterator<Item = S>, ) -> Self

Sets the parameter names (without $).

Trait Implementations

impl Clone for FunctionDecl

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionDecl

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

Formats the value using the given formatter.

impl Default for FunctionDecl

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FunctionDecl

where FunctionDecl: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FunctionDecl

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for FunctionDecl

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 FunctionDecl