Enum BuiltInConnectionString 

#[non_exhaustive]
pub enum BuiltInConnectionString {
    Http(Url),
    Ws(Url, Option<Authorization>),
    Ipc(PathBuf),
}

Connection string for built-in transports.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Http(Url)

Available on crate features reqwest or hyper only.

HTTP transport.

Ws(Url, Option<Authorization>)

Available on crate feature ws only.

WebSocket transport.

Ipc(PathBuf)

Available on crate feature ipc only.

IPC transport.

Implementations

impl BuiltInConnectionString

pub async fn connect(s: &str) -> Result<BoxTransport, TransportError>

Parse a connection string and connect to it in one go.

This is a convenience method that combines from_str and connect_boxed.

Example

use alloy_rpc_client::BuiltInConnectionString;

let transport = BuiltInConnectionString::connect("http://localhost:8545").await?;

pub async fn connect_with( s: &str, config: ConnectionConfig, ) -> Result<BoxTransport, TransportError>

Parse a connection string and connect with custom configuration.

This method allows for fine-grained control over connection settings such as authentication, retry behavior, and transport-specific options.

Examples

Basic usage with authentication:

use alloy_rpc_client::{BuiltInConnectionString, ConnectionConfig};
use alloy_transport::Authorization;
use std::time::Duration;

// Configure connection with custom settings
let config = ConnectionConfig::new()
    .with_auth(Authorization::bearer("my-token"))
    .with_max_retries(3)
    .with_retry_interval(Duration::from_secs(2));

// Connect to WebSocket endpoint with configuration
let transport = BuiltInConnectionString::connect_with("ws://localhost:8545", config).await?;

pub async fn connect_boxed(&self) -> Result<BoxTransport, TransportError>

Connect with the given connection string.

Notes

• If hyper feature is enabled
• WS will extract auth, however, auth is disabled for wasm.

pub async fn connect_boxed_with( &self, config: ConnectionConfig, ) -> Result<BoxTransport, TransportError>

Connect with the given connection string and custom configuration.

This method provides fine-grained control over connection settings. Configuration options are applied where supported by the transport.

Notes

• If hyper feature is enabled
• WS will extract auth, however, auth is disabled for wasm.
• Some configuration options may not apply to all transport types.

pub fn try_as_http(s: &str) -> Result<Self, TransportError>

Available on crate features reqwest or hyper only.

Tries to parse the given string as an HTTP URL.

pub fn try_as_ws(s: &str) -> Result<Self, TransportError>

Available on crate feature ws only.

Tries to parse the given string as a WebSocket URL.

pub fn try_as_ipc(s: &str) -> Result<Self, TransportError>

Available on crate feature ipc only.

Tries to parse the given string as an IPC path, returning an error if the path does not exist.

Trait Implementations

impl Clone for BuiltInConnectionString

fn clone(&self) -> BuiltInConnectionString

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BuiltInConnectionString

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

Formats the value using the given formatter.

impl FromStr for BuiltInConnectionString

type Err = RpcError<TransportErrorKind>

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for BuiltInConnectionString

fn eq(&self, other: &BuiltInConnectionString) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TransportConnect for BuiltInConnectionString

fn is_local(&self) -> bool

Returns true if the transport connects to a local resource.

async fn get_transport(&self) -> Result<BoxTransport, TransportError>

Connect to the transport, returning a Transport instance.

impl Eq for BuiltInConnectionString

impl StructuralPartialEq for BuiltInConnectionString

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 120 bytes

Size for each variant:

• Http: 96 bytes
• Ws: 120 bytes
• Ipc: 32 bytes