Struct jsonrpsee_http_client::HttpClientBuilder

pub struct HttpClientBuilder<L = Identity> { /* private fields */ }

Expand description

HTTP client builder.

§Examples


use jsonrpsee_http_client::{HttpClientBuilder, HeaderMap, HeaderValue};

#[tokio::main]
async fn main() {
    // Build custom headers used for every submitted request.
    let mut headers = HeaderMap::new();
    headers.insert("Any-Header-You-Like", HeaderValue::from_static("42"));

    // Build client
    let client = HttpClientBuilder::default()
         .set_headers(headers)
         .build("http://localhost")
         .unwrap();

    // use client....
}

Implementations§

impl<L> HttpClientBuilder<L>

pub fn max_request_size(self, size: u32) -> Self

Set the maximum size of a request body in bytes. Default is 10 MiB.

pub fn max_response_size(self, size: u32) -> Self

Set the maximum size of a response in bytes. Default is 10 MiB.

pub fn request_timeout(self, timeout: Duration) -> Self

Set request timeout (default is 60 seconds).

pub fn max_concurrent_requests(self, max: usize) -> Self

Set max concurrent requests.

pub fn use_native_rustls(self) -> Self

Force to use the rustls native certificate store.

Since multiple certificate stores can be optionally enabled, this option will force the native certificate store to be used.

§Optional

This requires the optional native-tls feature.

pub fn use_webpki_rustls(self) -> Self

Force to use the rustls webpki certificate store.

Since multiple certificate stores can be optionally enabled, this option will force the webpki certificate store to be used.

§Optional

This requires the optional webpki-tls feature.

pub fn id_format(self, id_kind: IdKind) -> Self

Configure the data type of the request object ID (default is number).

pub fn set_max_logging_length(self, max: u32) -> Self

Max length for logging for requests and responses in number characters.

Logs bigger than this limit will be truncated.

pub fn set_headers(self, headers: HeaderMap) -> Self

Set a custom header passed to the server with every request (default is none).

The caller is responsible for checking that the headers do not conflict or are duplicated.

pub fn set_tcp_no_delay(self, no_delay: bool) -> Self

Configure TCP_NODELAY on the socket to the supplied value nodelay.

Default is true.

pub fn set_http_middleware<T>( self, service_builder: ServiceBuilder<T> ) -> HttpClientBuilder<T>

Set custom tower middleware.

impl<B, S, L> HttpClientBuilder<L>
where L: Layer<HttpBackend, Service = S>, S: Service<Request<Body>, Response = Response<B>, Error = Error> + Clone, B: HttpBody + Send + 'static, B::Data: Send, B::Error: Into<Box<dyn StdError + Send + Sync>>,

pub fn build(self, target: impl AsRef<str>) -> Result<HttpClient<S>, Error>

Build the HTTP client with target to connect to.

impl HttpClientBuilder<Identity>

pub fn new() -> HttpClientBuilder<Identity>

Create a new builder.

Trait Implementations§

impl<L: Debug> Debug for HttpClientBuilder<L>

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

Formats the value using the given formatter. Read more

impl Default for HttpClientBuilder<Identity>

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

impl<L> Freeze for HttpClientBuilder<L>
where L: Freeze,

impl<L> RefUnwindSafe for HttpClientBuilder<L>
where L: RefUnwindSafe,

impl<L> Send for HttpClientBuilder<L>
where L: Send,

impl<L> Sync for HttpClientBuilder<L>
where L: Sync,

impl<L> Unpin for HttpClientBuilder<L>
where L: Unpin,

impl<L> UnwindSafe for HttpClientBuilder<L>
where L: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> MaybeSend for T
where T: Send,