Struct Function

pub struct Function {
    pub name: String,
    pub name_span: Span,
    pub renamed_via_js_name: bool,
    pub arguments: Vec<FunctionArgumentData>,
    pub ret: Option<FunctionReturnData>,
    pub rust_attrs: Vec<Attribute>,
    pub rust_vis: Visibility,
    pub unsafe: bool,
    pub async: bool,
    pub generate_typescript: bool,
    pub generate_jsdoc: bool,
    pub variadic: bool,
}

Information about a function being imported or exported

Fields

name: String

The name of the function

name_span: Span

The span of the function’s name in Rust code

renamed_via_js_name: bool

Whether the function has a js_name attribute

arguments: Vec<FunctionArgumentData>

The arguments to the function

ret: Option<FunctionReturnData>

The data of return type of the function

rust_attrs: Vec<Attribute>

Any custom attributes being applied to the function

rust_vis: Visibility

The visibility of this function in Rust

unsafe: bool

Whether this is an unsafe function

async: bool

Whether this is an async function

generate_typescript: bool

Whether to generate a typescript definition for this function

generate_jsdoc: bool

Whether to generate jsdoc documentation for this function

variadic: bool

Whether this is a function with a variadict parameter

Implementations

impl Function

pub fn infer_getter_property(&self) -> &str

If the rust object has a fn xxx(&self) -> MyType method, get the name for a getter in javascript (in this case xxx, so you can write val = obj.xxx)

pub fn infer_setter_property(&self) -> Result<String, Diagnostic>

If the rust object has a fn set_xxx(&mut self, MyType) style method, get the name for a setter in javascript (in this case xxx, so you can write obj.xxx = val)

Trait Implementations

impl Clone for Function

fn clone(&self) -> Function

Returns a copy of the value.

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

Performs copy-assignment from source.