Struct Rpc 

pub struct Rpc<Input, Output> { /* private fields */ }

Names one typed RPC exposed by a Flow.

Use the same value when binding the handler in RpcList and invoking it through crate::Client. Input and output types must implement Value. The stable name becomes part of the protocol and must remain compatible with running Flows.

Examples

use dex_sdk::{Context, Flow, HandlerResult, Rpc, RpcList, RpcResult};

const STATUS: Rpc<(), String> = Rpc::new("status");
struct OrderFlow;

impl OrderFlow {
    fn status(&self, _context: &mut Context) -> HandlerResult<RpcResult<String>> {
        Ok(RpcResult::new("ready".to_owned()))
    }
}

impl Flow for OrderFlow {
    type StartInput = ();

    fn rpcs(&self) -> RpcList<Self> {
        RpcList::new().function_without_input(STATUS, Self::status)
    }
}

Implementations

impl<Input, Output> Rpc<Input, Output>

pub const fn new(name: &'static str) -> Self

Defines an RPC with a stable protocol name and no option overrides.

pub fn timeout(self, timeout: Duration) -> RpcDefinition<Input, Output>

Converts this RPC into a definition with a handler execution timeout.

pub fn lock(self, lock: AttributeLock) -> RpcDefinition<Input, Output>

Converts this RPC into a definition holding one Attribute lock during invocation.

pub fn is_transactional(self) -> RpcDefinition<Input, Output>

Requests transactional reads and writes for this RPC.

pub fn load_attribute_map<T>( self, attribute_map: &AttributeMap<T>, ) -> RpcDefinition<Input, Output>

Converts this RPC into a definition that loads every current AttributeMap instance.

pub fn load_attribute_map_instance( self, load: AttributeMapLoad, ) -> RpcDefinition<Input, Output>

Converts this RPC into a definition that loads one AttributeMap instance.

pub fn load_channel<T>( self, channel: &Channel<T>, ) -> RpcDefinition<Input, Output>

Converts this RPC into a definition that loads one singleton Channel’s messages.

pub fn load_channel_map<T>( self, channel_map: &ChannelMap<T>, ) -> RpcDefinition<Input, Output>

Converts this RPC into a definition that loads every current ChannelMap instance.

pub fn load_channel_map_instance( self, load: ChannelMapLoad, ) -> RpcDefinition<Input, Output>

Converts this RPC into a definition that loads one ChannelMap instance.

Trait Implementations

impl<Input, Output> Clone for Rpc<Input, Output>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Input, Output> Copy for Rpc<Input, Output>

impl<Input, Output> From<Rpc<Input, Output>> for RpcDefinition<Input, Output>

fn from(rpc: Rpc<Input, Output>) -> Self

Converts to this type from the input type.