pub struct ImportFunction {
    pub function: Function,
    pub rust_name: Ident,
    pub js_ret: Option<Type>,
    pub catch: bool,
    pub variadic: bool,
    pub structural: bool,
    pub assert_no_shim: bool,
    pub kind: ImportFunctionKind,
    pub shim: Ident,
    pub doc_comment: Option<String>,
}
Expand description

A function being imported from JS

Fields

function: Function

The full signature of the function

rust_name: Ident

The name rust code will use

js_ret: Option<Type>

The type being returned

catch: bool

Whether to catch JS exceptions

variadic: bool

Whether the function is variadic on the JS side

structural: bool

Whether the function should use structural type checking

assert_no_shim: bool

Causes the Builder (See cli-support::js::binding::Builder) to error out if it finds itself generating code for a function with this signature

kind: ImportFunctionKind

The kind of function being imported

shim: Ident

The shim name to use in the generated code. The ‘shim’ is a function that appears in the generated JS as a wrapper around the actual function to import, performing any necessary conversions (EG adding a try/catch to change a thrown error into a Result)

doc_comment: Option<String>

The doc comment on this import, if one is provided

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Attempt to convert a Self into tokens and add it to the TokenStream

Attempt to convert a Self into a new TokenStream

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

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

The resulting type after obtaining ownership.

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

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

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.