Struct ClientBuilder 

pub struct ClientBuilder<B, W = JsonCodec> {
    inner: ClientConfig,
    byte_codec: B,
    ws_codec: W,
    executor: Option<Executor>,
}

Builder for constructing an RPC Client.

Example

use karyon_jsonrpc::client::ClientBuilder;

async {
    let client = ClientBuilder::new("tcp://127.0.0.1:60000")
        .expect("create builder")
        .set_timeout(5000)
        .build().await
        .expect("build client");

    let result: i32 = client
        .call("Calc.add", (1, 2))
        .await
        .expect("call method");
};

Fields

inner: ClientConfig

byte_codec: B

ws_codec: W

executor: Option<Executor>

Implementations

impl ClientBuilder<JsonCodec, JsonCodec>

pub fn new( endpoint: impl ToEndpoint, ) -> Result<ClientBuilder<JsonCodec, JsonCodec>>

Create a builder with the default JSON codec.

impl<B: JsonRpcCodec> ClientBuilder<B, JsonCodec>

pub fn new_with_codec( endpoint: impl ToEndpoint, codec: B, ) -> Result<ClientBuilder<B, JsonCodec>>

Create a builder with a custom byte-stream codec. The default JsonCodec is used for ws:// / wss:// endpoints; override with with_ws_codec.

impl<B, W> ClientBuilder<B, W>

where B: JsonRpcCodec, W: WsCodec,

pub fn set_timeout(self, timeout: u64) -> Self

Set request timeout in milliseconds.

pub fn set_max_subscription_buffer_size(self, size: usize) -> Self

Set max subscription buffer size.

pub fn tcp_config(self, config: TcpConfig) -> Result<Self>

Set TCP config.

pub fn tls_config(self, config: ClientTlsConfig) -> Result<Self>

Set TLS config.

pub fn quic_config(self, config: ClientQuicConfig) -> Result<Self>

Set QUIC config.

pub fn with_ws_codec<W2: WsCodec>(self, ws_codec: W2) -> ClientBuilder<B, W2>

Override the WebSocket codec. Only meaningful for ws:// / wss:// endpoints.

pub fn with_executor(self, ex: Executor) -> Self

Set an executor. Used for the client’s task group.

pub async fn build(self) -> Result<Arc<Client<B, W>>>

Build the client.