Struct ClientBuilder

pub struct ClientBuilder<L> { /* private fields */ }

A builder for the transport RpcClient.

This is a wrapper around tower::ServiceBuilder. It allows you to configure middleware layers that will be applied to the transport, and has some shortcuts for common layers and transports.

A builder accumulates Layers, and then is finished via the ClientBuilder::connect method, which produces an RPC client.

Implementations

impl<L> ClientBuilder<L>

pub fn layer<M>(self, layer: M) -> ClientBuilder<Stack<M, L>>

Add a middleware layer to the stack.

This is a wrapper around tower::ServiceBuilder::layer. Layers that are added first will be called with the request first.

pub fn transport<T>(self, transport: T, is_local: bool) -> RpcClient

where L: Layer<T>, T: IntoBoxTransport, L::Service: IntoBoxTransport,

Create a new RpcClient with the given transport and the configured layers.

This collapses the tower::ServiceBuilder with the given transport via tower::ServiceBuilder::service.

pub fn http(self, url: Url) -> RpcClient

where L: Layer<Http<Client>>, L::Service: IntoBoxTransport,

Available on crate feature reqwest only.

Convenience function to create a new RpcClient with a reqwest HTTP transport.

pub fn hyper_http(self, url: Url) -> RpcClient

where L: Layer<HyperTransport>, L::Service: IntoBoxTransport,

Available on non-WebAssembly and crate feature hyper only.

Convenience function to create a new RpcClient with a hyper HTTP transport.

pub async fn pubsub<C>(self, pubsub_connect: C) -> TransportResult<RpcClient>

where C: PubSubConnect, L: Layer<PubSubFrontend>, L::Service: IntoBoxTransport,

Available on crate feature pubsub only.

Connect a pubsub transport, producing an RpcClient with the provided connection.

pub async fn ws(self, ws_connect: WsConnect) -> TransportResult<RpcClient>

where L: Layer<PubSubFrontend>, L::Service: IntoBoxTransport,

Available on crate feature ws only.

Connect a WS transport, producing an RpcClient with the provided connection.

pub async fn ipc<T>( self, ipc_connect: IpcConnect<T>, ) -> TransportResult<RpcClient>

where IpcConnect<T>: PubSubConnect, L: Layer<PubSubFrontend>, L::Service: IntoBoxTransport,

Available on crate feature ipc only.

Connect an IPC transport, producing an RpcClient with the provided connection.

pub async fn connect(self, s: &str) -> TransportResult<RpcClient>

where L: Layer<BoxTransport>, L::Service: IntoBoxTransport,

Connect a transport specified by the given string, producing an RpcClient.

See BuiltInConnectionString for more information.

pub async fn connect_with<C>(self, connect: C) -> TransportResult<RpcClient>

where C: TransportConnect, L: Layer<BoxTransport>, L::Service: IntoBoxTransport,

Connect a transport, producing an RpcClient.

pub async fn connect_boxed<C>(self, connect: C) -> TransportResult<RpcClient>

where C: TransportConnect, L: Layer<BoxTransport>, L::Service: IntoBoxTransport,

👎Deprecated since 0.9.0: RpcClient is now always boxed, use connect_with instead

Connect a transport, producing an RpcClient with a BoxTransport connection.

Trait Implementations

impl<L: Debug> Debug for ClientBuilder<L>

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

Formats the value using the given formatter.

impl Default for ClientBuilder<Identity>

fn default() -> Self

Returns the “default value” for a type.

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.