Struct JsonRpcClient

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

A unc JSON RPC Client.

This is the main struct that you will use to interact with the unc JSON RPC API.

§Example

 use unc_jsonrpc_client::{methods, JsonRpcClient};
 use unc_primitives::types::{BlockReference, Finality};

 let client = JsonRpcClient::connect("https://rpc.testnet.unc.org");

 let request = methods::block::RpcBlockRequest {
     block_reference: BlockReference::Finality(Finality::Final),
 };

 let server_status = client.call(request).await?;

 println!("{:?}", server_status);

Implementations§

Source§

impl JsonRpcClient

Source

pub fn connect<U: AsUrl>(server_addr: U) -> JsonRpcClient

Connect to a JSON RPC server using the default connector.

It’s virtually the same as calling new_client().connect(server_addr). Only, this method optimally reuses the same connector across invocations.

§Example
use unc_jsonrpc_client::JsonRpcClient;

let client = JsonRpcClient::connect("https://rpc.testnet.unc.org");
Source

pub fn server_addr(&self) -> &str

Get the server address the client connects to.

It basically returns the server address passed to connect().

§Example
let client = JsonRpcClient::connect("https://rpc.testnet.unc.org");

assert_eq!(client.server_addr(), "https://rpc.testnet.unc.org");
Source

pub async fn call<M>( &self, method: M, ) -> MethodCallResult<M::Response, M::Error>
where M: RpcMethod,

RPC method executor for the client.

§Example
use unc_jsonrpc_client::{methods, JsonRpcClient};

let client = JsonRpcClient::connect("https://rpc.testnet.unc.org");

let request = methods::status::RpcStatusRequest;
let response = client.call(request).await?;

assert!(matches!(
    response,
    methods::status::RpcStatusResponse { .. }
));
Source

pub fn header<H, D>(self, entry: H) -> D::Output

Add a header to this request.

Depending on the header specified, this method either returns back the client, or a result containing the client.

§Example
use unc_jsonrpc_client::JsonRpcClient;

let client = JsonRpcClient::connect("https://rpc.testnet.unc.org");
let client = client.header(("user-agent", "someclient/0.1.0"))?; // <- returns a result

use unc_jsonrpc_client::auth;

let client = client.header(
    auth::ApiKey::new("cadc4c83-5566-4c94-aa36-773605150f44")?, // <- error handling here
); // <- returns the client
Source

pub fn headers(&self) -> &HeaderMap

Get a shared reference to the headers.

Source

pub fn headers_mut(&mut self) -> &mut HeaderMap

Get an exclusive reference to the headers.

Source

pub fn new_client() -> JsonRpcClientConnector

Manually create a new client connector.

It’s recommended to use the connect method instead as that method optimally reuses the default connector across invocations.

However, if for some reason you still need to manually create a new connector, you can do so. Just remember to properly reuse it as much as possible.

§Example
let client_connector = JsonRpcClient::new_client();

let mainnet_client = client_connector.connect("https://rpc.mainnet.unc.org");
let testnet_client = client_connector.connect("https://rpc.testnet.unc.org");
Source

pub fn with(client: Client) -> JsonRpcClientConnector

Create a new client constructor using a custom web client.

This is useful if you want to customize the reqwest::Client instance used by the JsonRpcClient.

§Example
use unc_jsonrpc_client::JsonRpcClient;

let web_client = reqwest::Client::builder()
    .proxy(reqwest::Proxy::all("https://192.168.1.1:4825")?)
    .build()?;

let testnet_client = JsonRpcClient::with(web_client).connect("https://rpc.testnet.unc.org");

Trait Implementations§

Source§

impl Clone for JsonRpcClient

Source§

fn clone(&self) -> JsonRpcClient

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

impl Debug for JsonRpcClient

Source§

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

Formats the value using the given formatter. Read more

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> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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<F, W, T, D> Deserialize<With<T, W>, D> for F
where W: DeserializeWith<F, T, D>, D: Fallible + ?Sized, F: ?Sized,

Source§

fn deserialize( &self, deserializer: &mut D, ) -> Result<With<T, W>, <D as Fallible>::Error>

Deserializes using the given deserializer
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The type for metadata in pointers and references to Self.
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 = Infallible

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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

impl<T> ErasedDestructor for T
where T: 'static,