Skip to main content

Rpc

Struct Rpc 

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

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§

Source§

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

Source

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

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

Source

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

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

Source

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

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

Trait Implementations§

Source§

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

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

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

Source§

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

Source§

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

Converts to this type from the input type.

Auto Trait Implementations§

§

impl<Input, Output> Freeze for Rpc<Input, Output>
where PhantomData<fn(Input) -> Output>: Freeze,

§

impl<Input, Output> RefUnwindSafe for Rpc<Input, Output>
where PhantomData<fn(Input) -> Output>: RefUnwindSafe,

§

impl<Input, Output> Send for Rpc<Input, Output>
where PhantomData<fn(Input) -> Output>: Send,

§

impl<Input, Output> Sync for Rpc<Input, Output>
where PhantomData<fn(Input) -> Output>: Sync,

§

impl<Input, Output> Unpin for Rpc<Input, Output>
where PhantomData<fn(Input) -> Output>: Unpin,

§

impl<Input, Output> UnsafeUnpin for Rpc<Input, Output>
where PhantomData<fn(Input) -> Output>: UnsafeUnpin,

§

impl<Input, Output> UnwindSafe for Rpc<Input, Output>
where PhantomData<fn(Input) -> Output>: UnwindSafe,

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> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more