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
impl JsonRpcClient
Sourcepub fn connect<U: AsUrl>(server_addr: U) -> JsonRpcClient
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");
Sourcepub fn server_addr(&self) -> &str
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");
Sourcepub async fn call<M>(
&self,
method: M,
) -> MethodCallResult<M::Response, M::Error>where
M: RpcMethod,
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 { .. }
));
Sourcepub fn header<H, D>(self, entry: H) -> D::Outputwhere
H: HeaderEntry<D>,
D: HeaderEntryDiscriminant<H>,
pub fn header<H, D>(self, entry: H) -> D::Outputwhere
H: HeaderEntry<D>,
D: HeaderEntryDiscriminant<H>,
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
Sourcepub fn headers_mut(&mut self) -> &mut HeaderMap
pub fn headers_mut(&mut self) -> &mut HeaderMap
Get an exclusive reference to the headers.
Sourcepub fn new_client() -> JsonRpcClientConnector
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");
Sourcepub fn with(client: Client) -> JsonRpcClientConnector
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
impl Clone for JsonRpcClient
Source§fn clone(&self) -> JsonRpcClient
fn clone(&self) -> JsonRpcClient
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for JsonRpcClient
impl !RefUnwindSafe for JsonRpcClient
impl Send for JsonRpcClient
impl Sync for JsonRpcClient
impl Unpin for JsonRpcClient
impl !UnwindSafe for JsonRpcClient
Blanket Implementations§
Source§impl<T> ArchivePointee for T
impl<T> ArchivePointee for T
Source§type ArchivedMetadata = ()
type ArchivedMetadata = ()
Source§fn pointer_metadata(
_: &<T as ArchivePointee>::ArchivedMetadata,
) -> <T as Pointee>::Metadata
fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<F, W, T, D> Deserialize<With<T, W>, D> for F
impl<F, W, T, D> Deserialize<With<T, W>, D> for F
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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