Skip to main content

PkHashmapMethod

Struct PkHashmapMethod 

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

A wrapper for std::collections::HashMap that implements the PkMethodAccessor trait.

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

§Note for Method Implementation type

The type Box<dyn Fn(Option<Vec<u8>>) -> Pin<Box<dyn Pollable>>> (as appeared in the second field of the tuple that new() accepts) is a boxed closure that takes an optional Vec<u8> as input, and returns a pinned Pollable. This allows method implementations to perform background work and return a Pollable that becomes ready when the work is complete.

The library provides some helper types for the Pollable trait:

And simply boxing them should work.

§Example with PkPromise

use pk_command::{PkHashmapMethod, PkPromise};
let methods = PkHashmapMethod::new(vec![(
    String::from("LONGT"),
    Box::new(|param| {
        PkPromise::execute(|resolve| {
            // do_something_with(param);
            resolve(b"task complete".to_vec());
        })
    }),
)]);

Implementations§

Source§

impl PkHashmapMethod

Source

pub fn new( init_vec: Vec<(String, Box<dyn Fn(Option<Vec<u8>>) -> Pin<Box<dyn Pollable>>>)>, ) -> Self

Creates a new PkHashmapMethod instance.

§Arguments
  • init_vec: A vector of tuples containing method keys and their corresponding implementation closures.

Trait Implementations§

Source§

impl PkMethodAccessor for PkHashmapMethod

Source§

fn call( &self, key: String, param: Vec<u8>, ) -> Result<Pin<Box<dyn Pollable>>, String>

Calls a method with the given parameters. 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, 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.