Struct workflow_rpc::client::RpcClient

impl<Ops, Id> RpcClient<Ops, Id>where
Ops: OpsT,
Id: IdT,

pub fn new_with_encoding(
 encoding: Encoding,
 interface: Option<Arc<Interface<Ops>>>,
 options: Options<'_>
) -> Result<RpcClient<Ops, Id>>

Create new wRPC client connecting to the supplied URL

This function accepts the Encoding enum argument denoting the underlying protocol that will be used by the client. Current variants supported are:

pub fn new<T>(
 interface: Option<Arc<Interface<Ops>>>,
 options: Options<'_>
) -> Result<RpcClient<Ops, Id>>where
 T: ProtocolHandler<Ops> + Send + Sync + 'static,

Create new wRPC client connecting to the supplied URL.

This function accepts a generic denoting the underlying protocol that will be used by the client. Current protocols supported are:

pub async fn connect(
&self,
block_until_connected: bool
) -> Result<Option<Listener>>

Connect to the target wRPC endpoint (websocket address)

pub async fn shutdown(&self) -> Result<()>

Stop wRPC client services

pub fn is_open(&self) -> bool

Test if the underlying WebSocket is currently open

pub async fn notify<Msg>(&self, op: Ops, payload: Msg) -> Result<()>where
Msg: BorshSerialize + Serialize + Send + Sync + 'static,

Issue an async Notification to the server (no response is expected)

Following are the trait requirements on the arguments:

Ops: OpsT
Msg: MsgT

pub async fn call<Req, Resp>(&self, op: Ops, req: Req) -> Result<Resp>where
Req: MsgT,
Resp: MsgT,

Issue an async wRPC call and wait for response.

Following are the trait requirements on the arguments:

Ops: OpsT
Req: MsgT
Resp: MsgT

Trait Implementations§

impl<Ops, Id> Clone for RpcClient<Ops, Id>where
Ops: OpsT + Clone,
Id: IdT + Clone,

fn clone(&self) -> RpcClient<Ops, Id>

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

impl<Ops, Id = Id64> !UnwindSafe for RpcClient<Ops, Id>

Blanket Implementations§

impl<T> Any for Twhere
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Any for Twhere
T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

fn type_name(&self) -> &'static str

impl<T> AnySync for Twhere
T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync + 'static>

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Downcast for Twhere
T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.

impl<T> DowncastSync for Twhere
T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.