Client

nym_node_requests::api

Struct Client 

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

A simple extendable client wrapper for http request with extra url sanitization.

Implementations§

Source§

impl Client

Source

pub fn new(base_url: Url, timeout: Option<Duration>) -> Client

Create a new http Client

Source

pub fn new_url<U>( url: U, timeout: Option<Duration>, ) -> Result<Client, HttpClientError>
where U: IntoUrl,

Attempt to create a new http client from a something that can be converted to a URL

Source

pub fn builder<U>(url: U) -> Result<ClientBuilder, HttpClientError>
where U: IntoUrl,

Creates a ClientBuilder to configure a Client.

This is the same as ClientBuilder::new().

Source

pub fn change_base_urls(&mut self, new_urls: Vec<Url>)

Update the set of hosts that this client uses when sending API requests.

Source

pub fn clone_with_new_url(&self, new_url: Url) -> Client

Create new instance of Client using the provided base url and existing client config

Source

pub fn current_url(&self) -> &Url

Get the currently configured host that this client uses when sending API requests.

Source

pub fn base_urls(&self) -> &[Url]

Get the currently configured host that this client uses when sending API requests.

Source

pub fn base_urls_mut(&mut self) -> &mut [Url]

Get a mutable reference to the hosts that this client uses when sending API requests.

Source

pub fn change_retry_limit(&mut self, limit: usize)

Change the currently configured limit on the number of retries for a request.

Trait Implementations§

Source§

impl ApiClientCore for Client

Source§

fn create_request<P, B, K, V>( &self, method: Method, path: P, params: &[(K, V)], body: Option<&B>, ) -> Result<RequestBuilder, HttpClientError>
where P: RequestPath, B: Serialize + ?Sized, K: AsRef<str>, V: AsRef<str>,

Create an HTTP request using the host configured in this client.
Source§

fn send<'life0, 'async_trait>( &'life0 self, request: RequestBuilder, ) -> Pin<Box<dyn Future<Output = Result<Response, HttpClientError>> + Send + 'async_trait>>
where 'life0: 'async_trait, Client: 'async_trait,

Send a created HTTP request. Read more
Source§

fn create_request_endpoint<B, S>( &self, method: Method, endpoint: S, body: Option<&B>, ) -> Result<RequestBuilder, HttpClientError>
where B: Serialize + ?Sized, S: AsRef<str>,

Create an HTTP request using the host configured in this client and an API endpoint (i.e. "/api/v1/mixnodes?since=12345"). If the provided endpoint fails to parse as path (and optionally query parameters). Read more
Source§

fn send_request<'life0, 'life1, 'life2, 'async_trait, P, B, K, V>( &'life0 self, method: Method, path: P, params: &'life1 [(K, V)], json_body: Option<&'life2 B>, ) -> Pin<Box<dyn Future<Output = Result<Response, HttpClientError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, P: RequestPath + Send + Sync + 'async_trait, B: Serialize + Sync + 'async_trait + ?Sized, K: AsRef<str> + Sync + 'async_trait, V: AsRef<str> + Sync + 'async_trait, Self: Sync + 'async_trait,

Create and send a created HTTP request.
Source§

impl Clone for Client

Source§

fn clone(&self) -> Client

Returns a duplicate 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 Client

Source§

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

Formats the value using the given formatter. Read more
Source§

impl NymNodeApiClientExt for Client

Source§

fn get_health<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<NodeHealth, NymNodeApiClientError>> + Send + 'async_trait>>
where Self: Sync + 'async_trait, 'life0: 'async_trait,

Source§

fn get_node_load<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<NodeLoad, NymNodeApiClientError>> + Send + 'async_trait>>
where Self: Sync + 'async_trait, 'life0: 'async_trait,

Source§

fn get_host_information<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<SignedHostInformation, NymNodeApiClientError>> + Send + 'async_trait>>
where Self: Sync + 'async_trait, 'life0: 'async_trait,

Source§

fn get_description<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<NodeDescription, NymNodeApiClientError>> + Send + 'async_trait>>
where Self: Sync + 'async_trait, 'life0: 'async_trait,

Source§

fn get_build_information<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<BinaryBuildInformationOwned, NymNodeApiClientError>> + Send + 'async_trait>>
where Self: Sync + 'async_trait, 'life0: 'async_trait,

Source§

fn get_roles<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<NodeRoles, NymNodeApiClientError>> + Send + 'async_trait>>
where Self: Sync + 'async_trait, 'life0: 'async_trait,

Source§

fn get_auxiliary_details<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<AuxiliaryDetails, NymNodeApiClientError>> + Send + 'async_trait>>
where Self: Sync + 'async_trait, 'life0: 'async_trait,

Source§

fn get_mixnet_websockets<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<WebSockets, NymNodeApiClientError>> + Send + 'async_trait>>
where Self: Sync + 'async_trait, 'life0: 'async_trait,

Source§

fn get_network_requester<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<NetworkRequester, NymNodeApiClientError>> + Send + 'async_trait>>
where Self: Sync + 'async_trait, 'life0: 'async_trait,

Source§

fn get_exit_policy<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<UsedExitPolicy, NymNodeApiClientError>> + Send + 'async_trait>>
where Self: Sync + 'async_trait, 'life0: 'async_trait,

Source§

fn get_ip_packet_router<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<IpPacketRouter, NymNodeApiClientError>> + Send + 'async_trait>>
where Self: Sync + 'async_trait, 'life0: 'async_trait,

Source§

fn get_authenticator<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Authenticator, NymNodeApiClientError>> + Send + 'async_trait>>
where Self: Sync + 'async_trait, 'life0: 'async_trait,

Source§

fn get_wireguard<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Wireguard, NymNodeApiClientError>> + Send + 'async_trait>>
where Self: Sync + 'async_trait, 'life0: 'async_trait,

Source§

fn get_sessions_metrics<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<SessionStats, NymNodeApiClientError>> + Send + 'async_trait>>
where Self: Sync + 'async_trait, 'life0: 'async_trait,

Source§

fn get_lewes_protocol<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<LewesProtocol, NymNodeApiClientError>> + Send + 'async_trait>>
where Self: Sync + 'async_trait, 'life0: 'async_trait,

Auto Trait Implementations§

§

impl !Freeze for Client

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

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<C> ApiClient for C
where C: ApiClientCore + Sync,

Source§

fn create_get_request<P, K, V>( &self, path: P, params: &[(K, V)], ) -> Result<RequestBuilder, HttpClientError>
where P: RequestPath, K: AsRef<str>, V: AsRef<str>,

Create an HTTP GET Request with the provided path and parameters
Source§

fn create_post_request<P, B, K, V>( &self, path: P, params: &[(K, V)], json_body: &B, ) -> Result<RequestBuilder, HttpClientError>
where P: RequestPath, B: Serialize + ?Sized, K: AsRef<str>, V: AsRef<str>,

Create an HTTP POST Request with the provided path, parameters, and json body
Source§

fn create_delete_request<P, K, V>( &self, path: P, params: &[(K, V)], ) -> Result<RequestBuilder, HttpClientError>
where P: RequestPath, K: AsRef<str>, V: AsRef<str>,

Create an HTTP DELETE Request with the provided path and parameters
Source§

fn create_patch_request<P, B, K, V>( &self, path: P, params: &[(K, V)], json_body: &B, ) -> Result<RequestBuilder, HttpClientError>
where P: RequestPath, B: Serialize + ?Sized, K: AsRef<str>, V: AsRef<str>,

Create an HTTP PATCH Request with the provided path, parameters, and json body
Source§

fn send_get_request<'life0, 'life1, 'async_trait, P, K, V>( &'life0 self, path: P, params: &'life1 [(K, V)], ) -> Pin<Box<dyn Future<Output = Result<Response, HttpClientError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, P: RequestPath + Send + Sync + 'async_trait, K: AsRef<str> + Sync + 'async_trait, V: AsRef<str> + Sync + 'async_trait, Self: Sync + 'async_trait,

Create and send an HTTP GET Request with the provided path and parameters
Source§

fn send_post_request<'life0, 'life1, 'life2, 'async_trait, P, B, K, V>( &'life0 self, path: P, params: &'life1 [(K, V)], json_body: &'life2 B, ) -> Pin<Box<dyn Future<Output = Result<Response, HttpClientError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, P: RequestPath + Send + Sync + 'async_trait, B: Serialize + Sync + 'async_trait + ?Sized, K: AsRef<str> + Sync + 'async_trait, V: AsRef<str> + Sync + 'async_trait, Self: Sync + 'async_trait,

Create and send an HTTP POST Request with the provided path, parameters, and json data
Source§

fn send_delete_request<'life0, 'life1, 'async_trait, P, K, V>( &'life0 self, path: P, params: &'life1 [(K, V)], ) -> Pin<Box<dyn Future<Output = Result<Response, HttpClientError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, P: RequestPath + Send + Sync + 'async_trait, K: AsRef<str> + Sync + 'async_trait, V: AsRef<str> + Sync + 'async_trait, Self: Sync + 'async_trait,

Create and send an HTTP DELETE Request with the provided path and parameters
Source§

fn send_patch_request<'life0, 'life1, 'life2, 'async_trait, P, B, K, V>( &'life0 self, path: P, params: &'life1 [(K, V)], json_body: &'life2 B, ) -> Pin<Box<dyn Future<Output = Result<Response, HttpClientError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, P: RequestPath + Send + Sync + 'async_trait, B: Serialize + Sync + 'async_trait + ?Sized, K: AsRef<str> + Sync + 'async_trait, V: AsRef<str> + Sync + 'async_trait, Self: Sync + 'async_trait,

Create and send an HTTP PATCH Request with the provided path, parameters, and json data
Source§

fn get_json<'life0, 'life1, 'async_trait, P, T, K, V>( &'life0 self, path: P, params: &'life1 [(K, V)], ) -> Pin<Box<dyn Future<Output = Result<T, HttpClientError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, P: RequestPath + Send + Sync + 'async_trait, T: for<'a> Deserialize<'a> + 'async_trait, K: AsRef<str> + Sync + 'async_trait, V: AsRef<str> + Sync + 'async_trait, Self: Sync + 'async_trait,

‘get’ json data from the segment-defined path, e.g. ["api", "v1", "mixnodes"], with tuple defined key-value parameters, e.g. [("since", "12345")]. Attempt to parse the response into the provided type T.
Source§

fn get_response<'life0, 'life1, 'async_trait, P, T, K, V>( &'life0 self, path: P, params: &'life1 [(K, V)], ) -> Pin<Box<dyn Future<Output = Result<T, HttpClientError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, P: RequestPath + Send + Sync + 'async_trait, T: for<'a> Deserialize<'a> + 'async_trait, K: AsRef<str> + Sync + 'async_trait, V: AsRef<str> + Sync + 'async_trait, Self: Sync + 'async_trait,

‘get’ data from the segment-defined path, e.g. ["api", "v1", "mixnodes"], with tuple defined key-value parameters, e.g. [("since", "12345")]. Attempt to parse the response into the provided type T based on the content type header
Source§

fn post_json<'life0, 'life1, 'life2, 'async_trait, P, B, T, K, V>( &'life0 self, path: P, params: &'life1 [(K, V)], json_body: &'life2 B, ) -> Pin<Box<dyn Future<Output = Result<T, HttpClientError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, P: RequestPath + Send + Sync + 'async_trait, B: Serialize + Sync + 'async_trait + ?Sized, T: for<'a> Deserialize<'a> + 'async_trait, K: AsRef<str> + Sync + 'async_trait, V: AsRef<str> + Sync + 'async_trait, Self: Sync + 'async_trait,

‘post’ json data to the segment-defined path, e.g. ["api", "v1", "mixnodes"], with tuple defined key-value parameters, e.g. [("since", "12345")]. Attempt to parse the response into the provided type T.
Source§

fn delete_json<'life0, 'life1, 'async_trait, P, T, K, V>( &'life0 self, path: P, params: &'life1 [(K, V)], ) -> Pin<Box<dyn Future<Output = Result<T, HttpClientError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, P: RequestPath + Send + Sync + 'async_trait, T: for<'a> Deserialize<'a> + 'async_trait, K: AsRef<str> + Sync + 'async_trait, V: AsRef<str> + Sync + 'async_trait, Self: Sync + 'async_trait,

‘delete’ json data from the segment-defined path, e.g. ["api", "v1", "mixnodes"], with tuple defined key-value parameters, e.g. [("since", "12345")]. Attempt to parse the response into the provided type T.
Source§

fn patch_json<'life0, 'life1, 'life2, 'async_trait, P, B, T, K, V>( &'life0 self, path: P, params: &'life1 [(K, V)], json_body: &'life2 B, ) -> Pin<Box<dyn Future<Output = Result<T, HttpClientError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, P: RequestPath + Send + Sync + 'async_trait, B: Serialize + Sync + 'async_trait + ?Sized, T: for<'a> Deserialize<'a> + 'async_trait, K: AsRef<str> + Sync + 'async_trait, V: AsRef<str> + Sync + 'async_trait, Self: Sync + 'async_trait,

‘patch’ json data at the segment-defined path, e.g. ["api", "v1", "mixnodes"], with tuple defined key-value parameters, e.g. [("since", "12345")]. Attempt to parse the response into the provided type T.
Source§

fn get_json_from<'life0, 'async_trait, T, S>( &'life0 self, endpoint: S, ) -> Pin<Box<dyn Future<Output = Result<T, HttpClientError>> + Send + 'async_trait>>
where 'life0: 'async_trait, T: for<'a> Deserialize<'a> + 'async_trait, S: AsRef<str> + Sync + Send + 'async_trait, Self: Sync + 'async_trait,

get json data from the provided absolute endpoint, e.g. "/api/v1/mixnodes?since=12345". Attempt to parse the response into the provided type T.
Source§

fn post_json_data_to<'life0, 'life1, 'async_trait, B, T, S>( &'life0 self, endpoint: S, json_body: &'life1 B, ) -> Pin<Box<dyn Future<Output = Result<T, HttpClientError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, B: Serialize + Sync + 'async_trait + ?Sized, T: for<'a> Deserialize<'a> + 'async_trait, S: AsRef<str> + Sync + Send + 'async_trait, Self: Sync + 'async_trait,

post json data to the provided absolute endpoint, e.g. "/api/v1/mixnodes?since=12345". Attempt to parse the response into the provided type T.
Source§

fn delete_json_from<'life0, 'async_trait, T, S>( &'life0 self, endpoint: S, ) -> Pin<Box<dyn Future<Output = Result<T, HttpClientError>> + Send + 'async_trait>>
where 'life0: 'async_trait, T: for<'a> Deserialize<'a> + 'async_trait, S: AsRef<str> + Sync + Send + 'async_trait, Self: Sync + 'async_trait,

delete json data from the provided absolute endpoint, e.g. "/api/v1/mixnodes?since=12345". Attempt to parse the response into the provided type T.
Source§

fn patch_json_data_at<'life0, 'life1, 'async_trait, B, T, S>( &'life0 self, endpoint: S, json_body: &'life1 B, ) -> Pin<Box<dyn Future<Output = Result<T, HttpClientError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, B: Serialize + Sync + 'async_trait + ?Sized, T: for<'a> Deserialize<'a> + 'async_trait, S: AsRef<str> + Sync + Send + 'async_trait, Self: Sync + 'async_trait,

patch json data at the provided absolute endpoint, e.g. "/api/v1/mixnodes?since=12345". Attempt to parse the response into the provided type T.
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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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