Struct neon::event::TaskBuilder

pub struct TaskBuilder<'cx, C, E> { /* fields omitted */ }

This is supported on crate feature task-api only.

Node asynchronous task builder

fn greet(mut cx: FunctionContext) -> JsResult<JsPromise> {
    let name = cx.argument::<JsString>(0)?.value(&mut cx);

    let promise = cx
        .task(move || format!("Hello, {}!", name))
        .promise(move |cx, greeting| Ok(cx.string(greeting)));

    Ok(promise)
}

Implementations

impl<'a: 'cx, 'cx, C, O, E> TaskBuilder<'cx, C, E> where
    C: Context<'a>,
    O: Send + 'static,
    E: FnOnce() -> O + Send + 'static, 

pub fn new(cx: &'cx mut C, execute: E) -> Self

Construct a new task builder from an execute callback that can be scheduled to execute on the Node worker pool

pub fn and_then<F>(self, complete: F) where
    F: FnOnce(&mut TaskContext<'_>, O) -> NeonResult<()> + Send + 'static, 

Schedules a task to execute on the Node worker pool, executing the complete callback on the JavaScript main thread with the result of the execute callback

pub fn promise<V, F>(self, complete: F) -> Handle<'a, JsPromise> where
    V: Value,
    for<'b> F: FnOnce(&mut TaskContext<'b>, O) -> JsResult<'b, V> + Send + 'static, 

This is supported on crate feature promise-api only.

Schedules a task to execute on the Node worker pool and returns a promise that is resolved with the value from the complete callback.

The complete callback will execute on the JavaScript main thread and is passed the return value from execute. If the complete callback throws, the promise will be rejected with the exception