Struct no_proto::rpc::NP_RPC_Factory

pub struct NP_RPC_Factory<'fact> { /* fields omitted */ }

RPC Factory

Implementations

impl<'fact> NP_RPC_Factory<'fact>

pub fn new(json_rcp_spec: &str) -> Result<Self, NP_Error>

Parse a JSON RPC spec into an RPC Factory

pub fn get_name(&self) -> &str

Get API name

pub fn get_author(&self) -> &str

Get API author

pub fn get_id(&self) -> String

Get API ID

pub fn get_version(&self) -> String

Get API Version

pub fn new_compiled(bytes_rpc_spec: &'fact [u8]) -> Result<Self, NP_Error>

Parse a byte rpc spec into an RPC Factory.

This method is orders of magnitude faster than the new method since there's no JSON to parse and only a few memory allocations.

pub fn compile_spec(&self) -> &[u8]

Get a copy of the compiled byte array specification

The compiled byte array is much faster to parse and takes up much less space.

If you don't need the verbosity of the JSON spec, use this instead.

pub fn new_request(
    &self,
    rpc_name: &str
) -> Result<NP_RPC_Request<'_>, NP_Error>

Generate a new request object for a given rpc function

pub fn open_request(
    &self,
    bytes: Vec<u8>
) -> Result<NP_RPC_Request<'_>, NP_Error>

Open a request. The request spec and version must match the current spec and version of this factory.

pub fn new_response(
    &self,
    rpc_name: &str
) -> Result<NP_RPC_Response<'_>, NP_Error>

Generate a new response object for a given rpc function

pub fn open_response(
    &self,
    bytes: Vec<u8>
) -> Result<NP_RPC_Response<'_>, NP_Error>

Open a response. The response spec and version must match the current spec and version of this factory.

Trait Implementations

impl<'fact> Debug for NP_RPC_Factory<'fact>

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.