Struct reth::builder::components::ComponentsBuilder

source ·
pub struct ComponentsBuilder<Node, PoolB, PayloadB, NetworkB, ExecB, ConsB> { /* private fields */ }
Expand description

A generic, general purpose and customizable NodeComponentsBuilder implementation.

This type is stateful and captures the configuration of the node’s components.

§Component dependencies:

The components of the node depend on each other:

  • The payload builder service depends on the transaction pool.
  • The network depends on the transaction pool.

We distinguish between different kind of components:

  • Components that are standalone, such as the transaction pool.
  • Components that are spawned as a service, such as the payload builder service or the network.

§Builder lifecycle:

First all standalone components are built. Then the service components are spawned. All component builders are captured in the builder state and will be consumed once the node is launched.

Implementations§

source§

impl<Node, PoolB, PayloadB, NetworkB, ExecB, ConsB> ComponentsBuilder<Node, PoolB, PayloadB, NetworkB, ExecB, ConsB>

source

pub fn node_types<Types>( self, ) -> ComponentsBuilder<Types, PoolB, PayloadB, NetworkB, ExecB, ConsB>
where Types: FullNodeTypes,

Configures the node types.

source

pub fn map_pool( self, f: impl FnOnce(PoolB) -> PoolB, ) -> ComponentsBuilder<Node, PoolB, PayloadB, NetworkB, ExecB, ConsB>

Apply a function to the pool builder.

source

pub fn map_payload( self, f: impl FnOnce(PayloadB) -> PayloadB, ) -> ComponentsBuilder<Node, PoolB, PayloadB, NetworkB, ExecB, ConsB>

Apply a function to the payload builder.

source

pub fn map_network( self, f: impl FnOnce(NetworkB) -> NetworkB, ) -> ComponentsBuilder<Node, PoolB, PayloadB, NetworkB, ExecB, ConsB>

Apply a function to the network builder.

source

pub fn map_executor( self, f: impl FnOnce(ExecB) -> ExecB, ) -> ComponentsBuilder<Node, PoolB, PayloadB, NetworkB, ExecB, ConsB>

Apply a function to the executor builder.

source

pub fn map_consensus( self, f: impl FnOnce(ConsB) -> ConsB, ) -> ComponentsBuilder<Node, PoolB, PayloadB, NetworkB, ExecB, ConsB>

Apply a function to the consensus builder.

source§

impl<Node, PoolB, PayloadB, NetworkB, ExecB, ConsB> ComponentsBuilder<Node, PoolB, PayloadB, NetworkB, ExecB, ConsB>
where Node: FullNodeTypes,

source

pub fn pool<PB>( self, pool_builder: PB, ) -> ComponentsBuilder<Node, PB, PayloadB, NetworkB, ExecB, ConsB>
where PB: PoolBuilder<Node>,

Configures the pool builder.

This accepts a PoolBuilder instance that will be used to create the node’s transaction pool.

source§

impl<Node, PoolB, PayloadB, NetworkB, ExecB, ConsB> ComponentsBuilder<Node, PoolB, PayloadB, NetworkB, ExecB, ConsB>
where Node: FullNodeTypes, PoolB: PoolBuilder<Node>,

source

pub fn network<NB>( self, network_builder: NB, ) -> ComponentsBuilder<Node, PoolB, PayloadB, NB, ExecB, ConsB>
where NB: NetworkBuilder<Node, <PoolB as PoolBuilder<Node>>::Pool>,

Configures the network builder.

This accepts a NetworkBuilder instance that will be used to create the node’s network stack.

source

pub fn payload<PB>( self, payload_builder: PB, ) -> ComponentsBuilder<Node, PoolB, PB, NetworkB, ExecB, ConsB>
where PB: PayloadServiceBuilder<Node, <PoolB as PoolBuilder<Node>>::Pool>,

Configures the payload builder.

This accepts a PayloadServiceBuilder instance that will be used to create the node’s payload builder service.

source

pub fn executor<EB>( self, executor_builder: EB, ) -> ComponentsBuilder<Node, PoolB, PayloadB, NetworkB, EB, ConsB>
where EB: ExecutorBuilder<Node>,

Configures the executor builder.

This accepts a ExecutorBuilder instance that will be used to create the node’s components for execution.

source

pub fn consensus<CB>( self, consensus_builder: CB, ) -> ComponentsBuilder<Node, PoolB, PayloadB, NetworkB, ExecB, CB>
where CB: ConsensusBuilder<Node>,

Configures the consensus builder.

This accepts a ConsensusBuilder instance that will be used to create the node’s components for consensus.

Trait Implementations§

source§

impl<Node, PoolB, PayloadB, NetworkB, ExecB, ConsB> Debug for ComponentsBuilder<Node, PoolB, PayloadB, NetworkB, ExecB, ConsB>
where Node: Debug, PoolB: Debug, PayloadB: Debug, NetworkB: Debug, ExecB: Debug, ConsB: Debug,

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for ComponentsBuilder<(), (), (), (), (), ()>

source§

fn default() -> ComponentsBuilder<(), (), (), (), (), ()>

Returns the “default value” for a type. Read more
source§

impl<Node, PoolB, PayloadB, NetworkB, ExecB, ConsB> NodeComponentsBuilder<Node> for ComponentsBuilder<Node, PoolB, PayloadB, NetworkB, ExecB, ConsB>
where Node: FullNodeTypes, PoolB: PoolBuilder<Node>, NetworkB: NetworkBuilder<Node, <PoolB as PoolBuilder<Node>>::Pool>, PayloadB: PayloadServiceBuilder<Node, <PoolB as PoolBuilder<Node>>::Pool>, ExecB: ExecutorBuilder<Node>, ConsB: ConsensusBuilder<Node>,

§

type Components = Components<Node, <PoolB as PoolBuilder<Node>>::Pool, <ExecB as ExecutorBuilder<Node>>::EVM, <ExecB as ExecutorBuilder<Node>>::Executor, <ConsB as ConsensusBuilder<Node>>::Consensus>

The components for the node with the given types
source§

async fn build_components( self, context: &BuilderContext<Node>, ) -> Result<<ComponentsBuilder<Node, PoolB, PayloadB, NetworkB, ExecB, ConsB> as NodeComponentsBuilder<Node>>::Components, Report>

Consumes the type and returns the created components.

Auto Trait Implementations§

§

impl<Node, PoolB, PayloadB, NetworkB, ExecB, ConsB> Freeze for ComponentsBuilder<Node, PoolB, PayloadB, NetworkB, ExecB, ConsB>
where PoolB: Freeze, PayloadB: Freeze, NetworkB: Freeze, ExecB: Freeze, ConsB: Freeze,

§

impl<Node, PoolB, PayloadB, NetworkB, ExecB, ConsB> RefUnwindSafe for ComponentsBuilder<Node, PoolB, PayloadB, NetworkB, ExecB, ConsB>
where PoolB: RefUnwindSafe, PayloadB: RefUnwindSafe, NetworkB: RefUnwindSafe, ExecB: RefUnwindSafe, ConsB: RefUnwindSafe, Node: RefUnwindSafe,

§

impl<Node, PoolB, PayloadB, NetworkB, ExecB, ConsB> Send for ComponentsBuilder<Node, PoolB, PayloadB, NetworkB, ExecB, ConsB>
where PoolB: Send, PayloadB: Send, NetworkB: Send, ExecB: Send, ConsB: Send, Node: Send,

§

impl<Node, PoolB, PayloadB, NetworkB, ExecB, ConsB> Sync for ComponentsBuilder<Node, PoolB, PayloadB, NetworkB, ExecB, ConsB>
where PoolB: Sync, PayloadB: Sync, NetworkB: Sync, ExecB: Sync, ConsB: Sync, Node: Sync,

§

impl<Node, PoolB, PayloadB, NetworkB, ExecB, ConsB> Unpin for ComponentsBuilder<Node, PoolB, PayloadB, NetworkB, ExecB, ConsB>
where PoolB: Unpin, PayloadB: Unpin, NetworkB: Unpin, ExecB: Unpin, ConsB: Unpin, Node: Unpin,

§

impl<Node, PoolB, PayloadB, NetworkB, ExecB, ConsB> UnwindSafe for ComponentsBuilder<Node, PoolB, PayloadB, NetworkB, ExecB, ConsB>
where PoolB: UnwindSafe, PayloadB: UnwindSafe, NetworkB: UnwindSafe, ExecB: UnwindSafe, ConsB: UnwindSafe, Node: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows 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) -> R
where R: 'a,

Mutably borrows 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
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows 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
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows 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
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .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
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .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
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeDebug for T
where T: Debug,

§

impl<T> MaybeSend for T
where 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.