pub struct RpcServerConfig<RpcMiddleware = Identity> { /* private fields */ }
Expand description
A builder type for configuring and launching the servers that will handle RPC requests.
Supported server transports are:
- http
- ws
- ipc
Http and WS share the same settings: ServerBuilder
.
Once the [RpcModule
] is built via RpcModuleBuilder
the servers can be started, See also
ServerBuilder::build
and Server::start
.
Implementations§
Source§impl RpcServerConfig
impl RpcServerConfig
Sourcepub fn http(config: Builder<Identity, Identity>) -> RpcServerConfig
pub fn http(config: Builder<Identity, Identity>) -> RpcServerConfig
Creates a new config with only http set
Sourcepub fn ws(config: Builder<Identity, Identity>) -> RpcServerConfig
pub fn ws(config: Builder<Identity, Identity>) -> RpcServerConfig
Creates a new config with only ws set
Sourcepub fn ipc(config: Builder<Identity, Identity>) -> RpcServerConfig
pub fn ipc(config: Builder<Identity, Identity>) -> RpcServerConfig
Creates a new config with only ipc set
Sourcepub fn with_http(self, config: Builder<Identity, Identity>) -> RpcServerConfig
pub fn with_http(self, config: Builder<Identity, Identity>) -> RpcServerConfig
Configures the http server
Note: this always configures an EthSubscriptionIdProvider
[IdProvider
] for
convenience. To set a custom [IdProvider
], please use Self::with_id_provider
.
Sourcepub fn with_ws(self, config: Builder<Identity, Identity>) -> RpcServerConfig
pub fn with_ws(self, config: Builder<Identity, Identity>) -> RpcServerConfig
Configures the ws server
Note: this always configures an EthSubscriptionIdProvider
[IdProvider
] for
convenience. To set a custom [IdProvider
], please use Self::with_id_provider
.
Sourcepub fn with_ipc(self, config: Builder<Identity, Identity>) -> RpcServerConfig
pub fn with_ipc(self, config: Builder<Identity, Identity>) -> RpcServerConfig
Configures the ipc server
Note: this always configures an EthSubscriptionIdProvider
[IdProvider
] for
convenience. To set a custom [IdProvider
], please use Self::with_id_provider
.
Source§impl<RpcMiddleware> RpcServerConfig<RpcMiddleware>
impl<RpcMiddleware> RpcServerConfig<RpcMiddleware>
Sourcepub fn set_rpc_middleware<T>(
self,
rpc_middleware: RpcServiceBuilder<T>,
) -> RpcServerConfig<T>
pub fn set_rpc_middleware<T>( self, rpc_middleware: RpcServiceBuilder<T>, ) -> RpcServerConfig<T>
Configure rpc middleware
Sourcepub fn with_cors(
self,
cors_domain: Option<String>,
) -> RpcServerConfig<RpcMiddleware>
pub fn with_cors( self, cors_domain: Option<String>, ) -> RpcServerConfig<RpcMiddleware>
Configure the cors domains for http and ws
Sourcepub fn with_ws_cors(
self,
cors_domain: Option<String>,
) -> RpcServerConfig<RpcMiddleware>
pub fn with_ws_cors( self, cors_domain: Option<String>, ) -> RpcServerConfig<RpcMiddleware>
Configure the cors domains for WS
Sourcepub fn with_http_cors(
self,
cors_domain: Option<String>,
) -> RpcServerConfig<RpcMiddleware>
pub fn with_http_cors( self, cors_domain: Option<String>, ) -> RpcServerConfig<RpcMiddleware>
Configure the cors domains for HTTP
Sourcepub const fn with_http_address(
self,
addr: SocketAddr,
) -> RpcServerConfig<RpcMiddleware>
pub const fn with_http_address( self, addr: SocketAddr, ) -> RpcServerConfig<RpcMiddleware>
Configures the SocketAddr
of the http server
Default is Ipv4Addr::LOCALHOST
and
reth_rpc_server_types::constants::DEFAULT_HTTP_RPC_PORT
Sourcepub const fn with_ws_address(
self,
addr: SocketAddr,
) -> RpcServerConfig<RpcMiddleware>
pub const fn with_ws_address( self, addr: SocketAddr, ) -> RpcServerConfig<RpcMiddleware>
Configures the SocketAddr
of the ws server
Default is Ipv4Addr::LOCALHOST
and
reth_rpc_server_types::constants::DEFAULT_WS_RPC_PORT
Sourcepub fn with_id_provider<I>(
self,
id_provider: I,
) -> RpcServerConfig<RpcMiddleware>where
I: IdProvider + Clone + 'static,
pub fn with_id_provider<I>(
self,
id_provider: I,
) -> RpcServerConfig<RpcMiddleware>where
I: IdProvider + Clone + 'static,
Sets a custom [IdProvider
] for all configured transports.
By default all transports use EthSubscriptionIdProvider
Sourcepub fn with_ipc_endpoint(
self,
path: impl Into<String>,
) -> RpcServerConfig<RpcMiddleware>
pub fn with_ipc_endpoint( self, path: impl Into<String>, ) -> RpcServerConfig<RpcMiddleware>
Configures the endpoint of the ipc server
Default is reth_rpc_server_types::constants::DEFAULT_IPC_ENDPOINT
Sourcepub const fn with_jwt_secret(
self,
secret: Option<JwtSecret>,
) -> RpcServerConfig<RpcMiddleware>
pub const fn with_jwt_secret( self, secret: Option<JwtSecret>, ) -> RpcServerConfig<RpcMiddleware>
Configures the JWT secret for authentication.
Sourcepub const fn has_server(&self) -> bool
pub const fn has_server(&self) -> bool
Returns true if any server is configured.
If no server is configured, no server will be launched on RpcServerConfig::start
.
Sourcepub const fn http_address(&self) -> Option<SocketAddr>
pub const fn http_address(&self) -> Option<SocketAddr>
Returns the SocketAddr
of the http server
Sourcepub const fn ws_address(&self) -> Option<SocketAddr>
pub const fn ws_address(&self) -> Option<SocketAddr>
Returns the SocketAddr
of the ws server
Sourcepub fn ipc_endpoint(&self) -> Option<String>
pub fn ipc_endpoint(&self) -> Option<String>
Returns the endpoint of the ipc server
Sourcepub async fn start(
self,
modules: &TransportRpcModules,
) -> Result<RpcServerHandle, RpcError>where
RpcMiddleware: Layer<RpcRequestMetricsService<RpcService>> + Clone + Send + 'static,
<RpcMiddleware as Layer<RpcRequestMetricsService<RpcService>>>::Service: for<'a> Send + for<'a> Sync + 'static + for<'a> RpcServiceT<'a>,
pub async fn start(
self,
modules: &TransportRpcModules,
) -> Result<RpcServerHandle, RpcError>where
RpcMiddleware: Layer<RpcRequestMetricsService<RpcService>> + Clone + Send + 'static,
<RpcMiddleware as Layer<RpcRequestMetricsService<RpcService>>>::Service: for<'a> Send + for<'a> Sync + 'static + for<'a> RpcServiceT<'a>,
Builds and starts the configured server(s): http, ws, ipc.
If both http and ws are on the same port, they are combined into one server.
Returns the RpcServerHandle
with the handle to the started servers.
Trait Implementations§
Source§impl<RpcMiddleware> Debug for RpcServerConfig<RpcMiddleware>where
RpcMiddleware: Debug,
impl<RpcMiddleware> Debug for RpcServerConfig<RpcMiddleware>where
RpcMiddleware: Debug,
Source§impl Default for RpcServerConfig
impl Default for RpcServerConfig
Source§fn default() -> RpcServerConfig
fn default() -> RpcServerConfig
Create a new config instance
Auto Trait Implementations§
impl<RpcMiddleware> Freeze for RpcServerConfig<RpcMiddleware>where
RpcMiddleware: Freeze,
impl<RpcMiddleware = Identity> !RefUnwindSafe for RpcServerConfig<RpcMiddleware>
impl<RpcMiddleware> Send for RpcServerConfig<RpcMiddleware>where
RpcMiddleware: Send,
impl<RpcMiddleware> Sync for RpcServerConfig<RpcMiddleware>where
RpcMiddleware: Sync,
impl<RpcMiddleware> Unpin for RpcServerConfig<RpcMiddleware>where
RpcMiddleware: Unpin,
impl<RpcMiddleware = Identity> !UnwindSafe for RpcServerConfig<RpcMiddleware>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling [Attribute
] value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
[Quirk
] value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the [Condition
] value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.§impl<T> TryConv for T
impl<T> TryConv for T
§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘwhere
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘwhere
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ
fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ
Source§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
Source§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘwhere
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘwhere
S: Into<Dispatch>,
Source§fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ
fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ
impl<T> ErasedDestructor for Twhere
T: 'static,
impl<T> MaybeDebug for Twhere
T: Debug,
impl<T> MaybeSend for Twhere
T: Send,
impl<T> MaybeSendSync for T
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.