Struct ProviderConfig

pub struct ProviderConfig { /* private fields */ }

Available on crate feature alloy only.

Configuration for an Alloy provider, sourced from an environment variable.

Implementations

impl ProviderConfig

pub const fn new(connection_string: BuiltInConnectionString) -> Self

Creates a new ProviderConfig from a connection string.

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 ProviderConfig

fn clone(&self) -> ProviderConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProviderConfig

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

Formats the value using the given formatter.

impl FromEnvVar for ProviderConfig

type Error = RpcError<TransportErrorKind>

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 ProviderConfig

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

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 Eq for ProviderConfig

impl StructuralPartialEq for ProviderConfig