Struct Boxed

pub struct Boxed<T>(pub T);

Wrapper to extract T from a JsBox<T> or create a JsBox from a T.

Boxed is especially useful for exporting async functions and tasks.

struct Greeter {
    greeting: String,
}

impl Finalize for Greeter {}

impl Greeter {
    fn new(greeting: String) -> Self {
        Self { greeting }
    }

    fn greet(&self, name: &str) -> String {
        format!("{}, {name}!", self.greeting)
    }
}

#[neon::export]
fn create_greeter(greeting: String) -> Boxed<Arc<Greeter>> {
    Boxed(Arc::new(Greeter::new(greeting)))
}

#[neon::export(task)]
fn greet(Boxed(greeter): Boxed<Arc<Greeter>>, name: String) -> String {
    greeter.greet(&name)
}

Tuple Fields

0: T

Trait Implementations

impl<'cx, T> TryFromJs<'cx> for Boxed<T>

where T: Clone + 'static,

type Error = TypeExpected<JsBox<T>>

fn try_from_js( cx: &mut Cx<'cx>, v: Handle<'cx, JsValue>, ) -> NeonResult<Result<Self, Self::Error>>

Extract this Rust type from a JavaScript value

fn from_js(cx: &mut Cx<'cx>, v: Handle<'cx, JsValue>) -> NeonResult<Self>

Same as TryFromJs, but all errors are converted to JavaScript exceptions

impl<'cx, T> TryIntoJs<'cx> for Boxed<T>

where T: Finalize + 'static,

type Value = JsBox<T>

The type of JavaScript value that will be created

fn try_into_js(self, cx: &mut Cx<'cx>) -> JsResult<'cx, Self::Value>

Convert self into a JavaScript value