TwirpHttpClient

Struct TwirpHttpClient 

Source
pub struct TwirpHttpClient<S: TwirpHttpService> { /* private fields */ }
Expand description

Underlying client used by autogenerated clients to handle networking.

Can be constructed with TwirpHttpClient::new_using_reqwest_012 to use reqwest 0.12 or from a regular tower::Service using TwirpHttpClient::new_with_base or TwirpHttpClient::new if relative URLs are fine.

URL grammar for twirp service is URL ::= Base-URL [ Prefix ] "/" [ Package "." ] Service "/" Method. The / [ Package "." ] Service "/" Method part is auto-generated by the build step but the Base-URL [ Prefix ] must be set to do proper call to remote services. This is the base_url parameter. If not filled, request URL is only going to be the auto-generated part.

Implementations§

Source§

impl TwirpHttpClient<Reqwest012Service>

Source

pub fn new_using_reqwest_012(base_url: impl Into<String>) -> Self

Available on crate feature reqwest-012 only.

Builds a new client using reqwest 0.12.

Note that base_url must be absolute with a scheme like https://.

use twurst_client::TwirpHttpClient;

let _client = TwirpHttpClient::new_using_reqwest_012("http://example.com/twirp");
Source

pub fn new_with_reqwest_012_client( client: Client, base_url: impl Into<String>, ) -> Self

Available on crate feature reqwest-012 only.

Builds a new client using reqwest 0.12.

Note that base_url must be absolute with a scheme like https://.

use twurst_client::TwirpHttpClient;

let _client =
    TwirpHttpClient::new_with_reqwest_012_client(Client::new(), "http://example.com/twirp");
Source§

impl<S: TwirpHttpService> TwirpHttpClient<S>

Source

pub fn new_with_base(service: S, base_url: impl Into<String>) -> Self

Builds a new client from a tower::Service and a base URL to the Twirp endpoint.

use http::Response;
use std::convert::Infallible;
use twurst_client::TwirpHttpClient;
use twurst_error::TwirpError;

let _client = TwirpHttpClient::new_with_base(
    tower::service_fn(|_request| async {
        Ok::<Response<String>, Infallible>(TwirpError::unimplemented("not implemented").into())
    }),
    "http://example.com/twirp",
);
Source

pub fn new(service: S) -> Self

New service without base URL. Relative URLs will be used for requests!

use http::Response;
use std::convert::Infallible;
use twurst_client::TwirpHttpClient;
use twurst_error::TwirpError;

let _client = TwirpHttpClient::new(tower::service_fn(|_request| async {
    Ok::<Response<String>, Infallible>(TwirpError::unimplemented("not implemented").into())
}));
Source

pub fn use_json(&mut self)

Use JSON for requests and response instead of binary protobuf encoding that is used by default

Source

pub fn use_binary_protobuf(&mut self)

Use binary protobuf encoding for requests and response (the default)

Source

pub async fn call<I: ReflectMessage, O: ReflectMessage + Default>( &self, path: &str, request: &I, ) -> Result<O, TwirpError>

Send a Twirp request and get a response.

Used internally by the generated code.

Trait Implementations§

Source§

impl<S: Clone + TwirpHttpService> Clone for TwirpHttpClient<S>

Source§

fn clone(&self) -> TwirpHttpClient<S>

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

Auto Trait Implementations§

§

impl<S> Freeze for TwirpHttpClient<S>
where S: Freeze,

§

impl<S> RefUnwindSafe for TwirpHttpClient<S>
where S: RefUnwindSafe,

§

impl<S> Send for TwirpHttpClient<S>

§

impl<S> Sync for TwirpHttpClient<S>
where S: Sync,

§

impl<S> Unpin for TwirpHttpClient<S>
where S: Unpin,

§

impl<S> UnwindSafe for TwirpHttpClient<S>
where S: UnwindSafe,

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

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