Struct Http

pub struct Http<T> { /* private fields */ }

An Http transport.

The user must provide an internal http client and a URL to which to connect. It implements Service<Box<RawValue>>, and therefore Transport.

Currently supported clients are:

• reqwest
• hyper

Implementations

impl Http<Client>

pub fn new(url: Url) -> Self

Available on crate feature reqwest only.

Create a new Http transport.

impl Http<HyperClient>

pub fn new_hyper(url: Url) -> Self

Available on non-WebAssembly and crate feature hyper only.

Create a new HyperTransport with the given URL and default hyper client.

impl<T> Http<T>

pub const fn with_client(client: T, url: Url) -> Self

Create a new Http transport with a custom client.

pub fn set_url(&mut self, url: Url)

Set the URL.

pub fn set_client(&mut self, client: T)

Set the client.

pub fn guess_local(&self) -> bool

Guess whether the URL is local, based on the hostname.

The output of this function is best-efforts, and should be checked if possible. It simply returns true if the connection has no hostname, or the hostname is localhost or 127.0.0.1.

pub const fn client(&self) -> &T

Get a reference to the client.

pub fn url(&self) -> &str

Get a reference to the URL.

Trait Implementations

impl<T: Clone> Clone for Http<T>

fn clone(&self) -> Http<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for Http<T>

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

Formats the value using the given formatter.

impl Service<RequestPacket> for &Http<Client>

Available on crate feature reqwest only.

type Response = ResponsePacket

Responses given by the service.

type Error = RpcError<TransportErrorKind>

Errors produced by the service.

type Future = Pin<Box<dyn Future<Output = Result<ResponsePacket, RpcError<TransportErrorKind>>> + Send>>

The future response value.

fn poll_ready(&mut self, _cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.

fn call(&mut self, req: RequestPacket) -> Self::Future

Process the request and return the response asynchronously.

impl<B, S> Service<RequestPacket> for &Http<HyperClient<B, S>>

where S: Service<Request<B>, Response = HyperResponse> + Clone + Send + Sync + 'static, S::Future: Send, S::Error: Error + Send + Sync + 'static, B: From<Vec<u8>> + Send + 'static + Clone + Sync,

Available on non-WebAssembly and crate feature hyper only.

type Response = ResponsePacket

Responses given by the service.

type Error = RpcError<TransportErrorKind>

Errors produced by the service.

type Future = Pin<Box<dyn Future<Output = Result<ResponsePacket, RpcError<TransportErrorKind>>> + Send>>

The future response value.

fn poll_ready(&mut self, _cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.

fn call(&mut self, req: RequestPacket) -> Self::Future

Process the request and return the response asynchronously.

impl Service<RequestPacket> for Http<Client>

Available on crate feature reqwest only.

type Response = ResponsePacket

Responses given by the service.

type Error = RpcError<TransportErrorKind>

Errors produced by the service.

type Future = Pin<Box<dyn Future<Output = Result<ResponsePacket, RpcError<TransportErrorKind>>> + Send>>

The future response value.

fn poll_ready(&mut self, _cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.

fn call(&mut self, req: RequestPacket) -> Self::Future

Process the request and return the response asynchronously.

impl<B, S> Service<RequestPacket> for Http<HyperClient<B, S>>

where S: Service<Request<B>, Response = HyperResponse> + Clone + Send + Sync + 'static, S::Future: Send, S::Error: Error + Send + Sync + 'static, B: From<Vec<u8>> + Send + 'static + Clone + Sync,

Available on non-WebAssembly and crate feature hyper only.

type Response = ResponsePacket

Responses given by the service.

type Error = RpcError<TransportErrorKind>

Errors produced by the service.

type Future = Pin<Box<dyn Future<Output = Result<ResponsePacket, RpcError<TransportErrorKind>>> + Send>>

The future response value.

fn poll_ready(&mut self, _cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.

fn call(&mut self, req: RequestPacket) -> Self::Future

Process the request and return the response asynchronously.