Skip to main content

ApiClient

Struct ApiClient 

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

Generic async JSON REST client. Generic async JSON REST client.

This client is transport-focused and does not require an OpenAPI operation id. For operation-id based calls generated from openapi/openapi.json, use crate::IriClient.

Implementations§

Source§

impl ApiClient

Source

pub fn new(base_url: impl AsRef<str>) -> Result<Self, ClientError>

Creates a new client with the given base URL.

The URL is normalized to include a trailing slash, so relative endpoint paths join correctly.

Source

pub fn with_authorization_token(self, token: impl Into<String>) -> Self

Returns a new client with a raw access token attached to all requests.

This sets Authorization: <token> (without Bearer prefix).

Source

pub async fn get_json(&self, path: &str) -> Result<Value, ClientError>

Sends a GET request and parses the response as JSON.

Source

pub async fn get_json_with_query( &self, path: &str, query: &[(&str, &str)], ) -> Result<Value, ClientError>

Sends a GET request with query parameters and parses the response as JSON.

Source

pub async fn post_json( &self, path: &str, body: Value, ) -> Result<Value, ClientError>

Sends a POST request with a JSON body and parses the response as JSON.

Source

pub async fn put_json( &self, path: &str, body: Value, ) -> Result<Value, ClientError>

Sends a PUT request with a JSON body and parses the response as JSON.

Source

pub async fn delete_json(&self, path: &str) -> Result<Value, ClientError>

Sends a DELETE request and parses the response as JSON.

Source

pub async fn request_json( &self, method: Method, path: &str, body: Option<Value>, ) -> Result<Value, ClientError>

Sends a request and parses the response as JSON.

Use Self::request_json_with_query when query parameters are needed.

Source

pub async fn request_json_with_query( &self, method: Method, path: &str, query: &[(&str, &str)], body: Option<Value>, ) -> Result<Value, ClientError>

Sends a request with query parameters and parses the response as JSON.

Returns Value::Null for successful responses with an empty body.

Trait Implementations§

Source§

impl Clone for ApiClient

Source§

fn clone(&self) -> ApiClient

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 ApiClient

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