pub struct Function {
    pub name: String,
    pub name_span: Span,
    pub renamed_via_js_name: bool,
    pub arguments: Vec<PatType>,
    pub ret: Option<Type>,
    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,
}
Expand description

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<PatType>

The arguments to the function

§ret: Option<Type>

The return type of the function, if provided

§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§

source§

impl Function

source

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)

source

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§

source§

impl Clone for Function

source§

fn clone(&self) -> Function

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.