Skip to main content

PkPromise

Struct PkPromise 

Source
pub struct PkPromise { /* private fields */ }
Available on crate feature std only.
Expand description

A simple implementation of Pollable that executes tasks in a background thread.

This is similar to a JavaScript Promise. It allows offloading work to another thread and polling for its completion within the PK protocol’s poll() cycle.

Note: This is only available when the std feature is enabled.

Implementations§

Source§

impl PkPromise

Source

pub fn execute<T>(function: T) -> Pin<Box<Self>>
where T: FnOnce(Box<dyn FnOnce(Vec<u8>) + Send + 'static>) + Send + 'static,

Executes a closure in a new thread and returns a Pollable handle.

The provided closure function receives a resolve callback. Call resolve(data) when the task is complete to make the data available.

§Arguments
  • function: A closure that performs the task and calls the provided resolve callback.
§Example
use pk_command::PkPromise;
let promise = PkPromise::execute(|resolve| {
    // Do expensive work...
    resolve(b"done".to_vec());
});
§Example with PK Command
use pk_command::{PkCommand, PkCommandConfig, PkHashmapMethod, PkHashmapVariable, PkPromise};
let vars = PkHashmapVariable::new(vec![]);
let methods = PkHashmapMethod::new(vec![(
    "LONGT".to_string(),
    Box::new(|param| {
        PkPromise::execute(|resolve| {
            // do_something_with(param);
            resolve(b"task complete".to_vec());
        })
    }),
)]);
let config = PkCommandConfig::default(64);
let pk = PkCommand::<_, _, std::time::Instant>::new(config, vars, methods);
// main loop...

Trait Implementations§

Source§

impl Clone for PkPromise

Source§

fn clone(&self) -> PkPromise

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Pollable for PkPromise

Source§

fn poll(&self) -> Poll<Result<Option<Vec<u8>>, String>>

Polls the operation for completion. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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,

Source§

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

Source§

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

Source§

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.