Struct PubSubConfig

pub struct PubSubConfig { /* private fields */ }

Available on crate feature alloy only.

Configuration for an Alloy provider, used to create a client, enforces pubsub availability (WS or IPC connection).

Implementations

impl PubSubConfig

pub const fn connection_string(&self) -> &BuiltInConnectionString

Returns the connection string.

pub async fn connect(&self) -> TransportResult<RootProvider>

Connects to the provider using the connection string.

Trait Implementations

impl Clone for PubSubConfig

fn clone(&self) -> PubSubConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PubSubConfig

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

Formats the value using the given formatter.

impl FromEnvVar for PubSubConfig

type Error = ProviderConnectError

Error type produced when parsing the primitive.

fn from_env_var(env_var: &str) -> Result<Self, FromEnvErr<Self::Error>>

Load the primitive from the environment at the given variable.

fn from_env_var_or( env_var: &str, default: Self, ) -> Result<Self, FromEnvErr<Self::Error>>

Load the primitive from the environment at the given variable. If the variable is unset or empty, return the default value.

fn from_env_var_or_else( env_var: &str, default: impl FnOnce() -> Self, ) -> Result<Self, FromEnvErr<Self::Error>>

Load the primitive from the environment at the given variable. If the variable is unset or empty, call the provided function to get the default value.

impl PartialEq for PubSubConfig

fn eq(&self, other: &PubSubConfig) -> 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 PubSubConnect for PubSubConfig

fn is_local(&self) -> bool

Returns true if the transport connects to a local resource.

fn connect( &self, ) -> impl Send + Future<Output = TransportResult<ConnectionHandle>>

Spawn the backend, returning a handle to it.

fn try_reconnect( &self, ) -> impl Send + Future<Output = Result<ConnectionHandle, RpcError<TransportErrorKind>>>

Attempt to reconnect the transport.

fn into_service( self, ) -> impl Send + Future<Output = Result<PubSubFrontend, RpcError<TransportErrorKind>>>

Convert the configuration object into a service with a running backend.

impl TransportConnect for PubSubConfig

fn is_local(&self) -> bool

Returns true if the transport connects to a local resource.

fn get_transport( &self, ) -> impl Send + Future<Output = Result<BoxTransport, TransportError>>

Connect to the transport, returning a Transport instance.

impl TryFrom<BuiltInConnectionString> for PubSubConfig

type Error = ProviderConnectError

The type returned in the event of a conversion error.

fn try_from( connection_string: BuiltInConnectionString, ) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for PubSubConfig

impl StructuralPartialEq for PubSubConfig