Skip to main content

Client

Struct Client 

Source
pub struct Client { /* private fields */ }
Expand description

Unix-socket JSON-RPC client (one in-flight request per connection).

See the module docs for examples.

Implementations§

Source§

impl Client

Source

pub fn builder() -> ClientBuilder

Start a ClientBuilder.

§Examples
use simplejrpc::Client;
let _ = Client::builder().socket("/tmp/app.sock");
Source

pub async fn connect(path: impl AsRef<Path>) -> Result<Self>

Dial a Unix socket and return a connected client.

§Examples
use simplejrpc::Client;
let client = Client::connect("/tmp/simplejrpc.sock").await?;
Source

pub fn from_stream(stream: UnixStream) -> Self

Wrap an existing connected stream (tests / custom dialers).

§Examples
use simplejrpc::Client;
let _ = Client::from_stream(stream);
Source

pub fn next_request_id(&self) -> i64

Allocate the next monotonic JSON-RPC request id.

§Examples
use simplejrpc::Client;
let c = Client::connect("/tmp/simplejrpc.sock").await?;
assert_eq!(c.next_request_id(), 1);
assert_eq!(c.next_request_id(), 2);
Source

pub async fn call(&self, method: &str, params: Value) -> Result<Value>

Call a method and return the app envelope data when code == 200.

If the envelope reports a non-200 code, returns Error::Biz with that code and message (still a transport-level success).

§Examples
use simplejrpc::Client;
use serde_json::json;
let c = Client::connect("/tmp/simplejrpc.sock").await?;
let v = c.call("ping", json!({})).await?;
Source

pub async fn call_envelope( &self, method: &str, params: Value, ) -> Result<AppResponse>

Call a method and return the full AppResponse envelope.

Use this when you need code / msg / meta (for example 404 method missing still yields a JSON-RPC result, not a JSON-RPC error).

§Examples
use simplejrpc::Client;
use serde_json::json;
let c = Client::connect("/tmp/simplejrpc.sock").await?;
let env = c.call_envelope("missing", json!({})).await?;
assert_eq!(env.code, 404);
Source

pub async fn exchange_frame(&self, framed: &[u8]) -> Result<Vec<u8>>

Write one framed request and read exactly one framed response.

Exposed so wrappers can customize request building while reusing the locked stream exchange.

§Examples
use simplejrpc::client::encode_rpc_request;
use serde_json::json;
let framed = encode_rpc_request(1, "ping", json!({}))?;
let _body = c.exchange_frame(&framed).await?;

Trait Implementations§

Source§

impl RpcClient for Client

Source§

fn call_envelope<'life0, 'life1, 'async_trait>( &'life0 self, method: &'life1 str, params: Value, ) -> Pin<Box<dyn Future<Output = Result<AppResponse>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Full app envelope (code / msg / data / meta).
Source§

fn call<'life0, 'life1, 'async_trait>( &'life0 self, method: &'life1 str, params: Value, ) -> Pin<Box<dyn Future<Output = Result<Value>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Envelope data when code == 200; otherwise Error::Biz.

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> 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, 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, !>

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