pub struct RpcAddOns<Node, EthApi, EV>where
Node: FullNodeComponents,
EthApi: EthApiTypes,{
pub hooks: RpcHooks<Node, EthApi>,
/* private fields */
}
Expand description
Node add-ons containing RPC server configuration, with customizable eth API handler.
Fields§
§hooks: RpcHooks<Node, EthApi>
Additional RPC add-ons.
Implementations§
Source§impl<Node, EthApi, EV> RpcAddOns<Node, EthApi, EV>where
Node: FullNodeComponents,
EthApi: EthApiTypes,
impl<Node, EthApi, EV> RpcAddOns<Node, EthApi, EV>where
Node: FullNodeComponents,
EthApi: EthApiTypes,
Sourcepub fn new(
eth_api_builder: impl FnOnce(&EthApiBuilderCtx<<Node as RpcNodeCore>::Provider, <Node as RpcNodeCore>::Pool, <Node as RpcNodeCore>::Evm, <Node as RpcNodeCore>::Network, TaskExecutor, <Node as RpcNodeCore>::Provider>) -> EthApi + Send + Sync + 'static,
engine_validator_builder: EV,
) -> RpcAddOns<Node, EthApi, EV>
pub fn new( eth_api_builder: impl FnOnce(&EthApiBuilderCtx<<Node as RpcNodeCore>::Provider, <Node as RpcNodeCore>::Pool, <Node as RpcNodeCore>::Evm, <Node as RpcNodeCore>::Network, TaskExecutor, <Node as RpcNodeCore>::Provider>) -> EthApi + Send + Sync + 'static, engine_validator_builder: EV, ) -> RpcAddOns<Node, EthApi, EV>
Creates a new instance of the RPC add-ons.
Sourcepub fn on_rpc_started<F>(self, hook: F) -> RpcAddOns<Node, EthApi, EV>where
F: FnOnce(RpcContext<'_, Node, EthApi>, RethRpcServerHandles) -> Result<(), Report> + Send + 'static,
pub fn on_rpc_started<F>(self, hook: F) -> RpcAddOns<Node, EthApi, EV>where
F: FnOnce(RpcContext<'_, Node, EthApi>, RethRpcServerHandles) -> Result<(), Report> + Send + 'static,
Sets the hook that is run once the rpc server is started.
Sourcepub fn extend_rpc_modules<F>(self, hook: F) -> RpcAddOns<Node, EthApi, EV>
pub fn extend_rpc_modules<F>(self, hook: F) -> RpcAddOns<Node, EthApi, EV>
Sets the hook that is run to configure the rpc modules.
Source§impl<N, EthApi, EV> RpcAddOns<N, EthApi, EV>where
<N as FullNodeComponents>::Pool: TransactionPool,
<<N as FullNodeComponents>::Pool as TransactionPool>::Transaction: PoolTransaction<Pooled = PooledTransaction>,
EthApi: EthApiTypes + FullEthApiServer<Provider = <N as FullNodeTypes>::Provider, Pool = <N as FullNodeComponents>::Pool, Network = <N as FullNodeComponents>::Network> + AddDevSigners + Unpin + 'static,
N: FullNodeComponents,
EV: EngineValidatorBuilder<N>,
impl<N, EthApi, EV> RpcAddOns<N, EthApi, EV>where
<N as FullNodeComponents>::Pool: TransactionPool,
<<N as FullNodeComponents>::Pool as TransactionPool>::Transaction: PoolTransaction<Pooled = PooledTransaction>,
EthApi: EthApiTypes + FullEthApiServer<Provider = <N as FullNodeTypes>::Provider, Pool = <N as FullNodeComponents>::Pool, Network = <N as FullNodeComponents>::Network> + AddDevSigners + Unpin + 'static,
N: FullNodeComponents,
EV: EngineValidatorBuilder<N>,
Sourcepub async fn launch_add_ons_with<F>(
self,
ctx: AddOnsContext<'_, N>,
ext: F,
) -> Result<RpcHandle<N, EthApi>, Report>
pub async fn launch_add_ons_with<F>( self, ctx: AddOnsContext<'_, N>, ext: F, ) -> Result<RpcHandle<N, EthApi>, Report>
Launches the RPC servers with the given context and an additional hook for extending modules.
Trait Implementations§
Source§impl<N, EthApi, EV> EngineValidatorAddOn<N> for RpcAddOns<N, EthApi, EV>
impl<N, EthApi, EV> EngineValidatorAddOn<N> for RpcAddOns<N, EthApi, EV>
Source§type Validator = <EV as EngineValidatorBuilder<N>>::Validator
type Validator = <EV as EngineValidatorBuilder<N>>::Validator
Source§async fn engine_validator(
&self,
ctx: &AddOnsContext<'_, N>,
) -> Result<<RpcAddOns<N, EthApi, EV> as EngineValidatorAddOn<N>>::Validator, Report>
async fn engine_validator( &self, ctx: &AddOnsContext<'_, N>, ) -> Result<<RpcAddOns<N, EthApi, EV> as EngineValidatorAddOn<N>>::Validator, Report>
Source§impl<N, EthApi, EV> NodeAddOns<N> for RpcAddOns<N, EthApi, EV>where
<N as FullNodeComponents>::Pool: TransactionPool,
<<N as FullNodeComponents>::Pool as TransactionPool>::Transaction: PoolTransaction<Pooled = PooledTransaction>,
EthApi: EthApiTypes + FullEthApiServer<Provider = <N as FullNodeTypes>::Provider, Pool = <N as FullNodeComponents>::Pool, Network = <N as FullNodeComponents>::Network> + AddDevSigners + Unpin + 'static,
N: FullNodeComponents,
<N as FullNodeTypes>::Types: NodeTypesForProvider<Primitives = EthPrimitives>,
EV: EngineValidatorBuilder<N>,
impl<N, EthApi, EV> NodeAddOns<N> for RpcAddOns<N, EthApi, EV>where
<N as FullNodeComponents>::Pool: TransactionPool,
<<N as FullNodeComponents>::Pool as TransactionPool>::Transaction: PoolTransaction<Pooled = PooledTransaction>,
EthApi: EthApiTypes + FullEthApiServer<Provider = <N as FullNodeTypes>::Provider, Pool = <N as FullNodeComponents>::Pool, Network = <N as FullNodeComponents>::Network> + AddDevSigners + Unpin + 'static,
N: FullNodeComponents,
<N as FullNodeTypes>::Types: NodeTypesForProvider<Primitives = EthPrimitives>,
EV: EngineValidatorBuilder<N>,
Source§async fn launch_add_ons(
self,
ctx: AddOnsContext<'_, N>,
) -> Result<<RpcAddOns<N, EthApi, EV> as NodeAddOns<N>>::Handle, Report>
async fn launch_add_ons( self, ctx: AddOnsContext<'_, N>, ) -> Result<<RpcAddOns<N, EthApi, EV> as NodeAddOns<N>>::Handle, Report>
Source§impl<N, EthApi, EV> RethRpcAddOns<N> for RpcAddOns<N, EthApi, EV>where
N: FullNodeComponents,
EthApi: EthApiTypes,
RpcAddOns<N, EthApi, EV>: NodeAddOns<N, Handle = RpcHandle<N, EthApi>>,
impl<N, EthApi, EV> RethRpcAddOns<N> for RpcAddOns<N, EthApi, EV>where
N: FullNodeComponents,
EthApi: EthApiTypes,
RpcAddOns<N, EthApi, EV>: NodeAddOns<N, Handle = RpcHandle<N, EthApi>>,
Auto Trait Implementations§
impl<Node, EthApi, EV> Freeze for RpcAddOns<Node, EthApi, EV>where
EV: Freeze,
impl<Node, EthApi, EV> !RefUnwindSafe for RpcAddOns<Node, EthApi, EV>
impl<Node, EthApi, EV> Send for RpcAddOns<Node, EthApi, EV>where
EV: Send,
impl<Node, EthApi, EV> !Sync for RpcAddOns<Node, EthApi, EV>
impl<Node, EthApi, EV> Unpin for RpcAddOns<Node, EthApi, EV>
impl<Node, EthApi, EV> !UnwindSafe for RpcAddOns<Node, EthApi, EV>
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.