Struct paxakos::node_builder::NodeBuilder

source ·

pub struct NodeBuilder<N: Node, F: Finisher<Node = N>, V = IndiscriminateVoterFor<N>, B = InMemoryBuffer<RoundNumOf<N>, CoordNumOf<N>, LogEntryOf<N>>, C = ()> { /* private fields */ }

Expand description

Node builder with all essential information set.

Implementations

source

impl<N, F, V, B, C> NodeBuilder<N, F, V, B, C>where
 N: NodeImpl + 'static,
 F: Finisher<Node = N>,
 V: Voter<State = StateOf<N>, RoundNum = RoundNumOf<N>, CoordNum = CoordNumOf<N>, Abstain = AbstainOf<N>, Yea = YeaOf<N>, Nay = NayOf<N>>,
 B: Buffer<RoundNum = RoundNumOf<N>, CoordNum = CoordNumOf<N>, Entry = LogEntryOf<N>>,

source

pub fn buffering_applied_entries_in<T: Buffer<RoundNum = RoundNumOf<N>, CoordNum = CoordNumOf<N>, Entry = LogEntryOf<N>>>(
self,
buffer: T
) -> NodeBuilder<N, F, V, T, C>

Sets the applied entry buffer.

source

pub fn in_context<T>(self, context: T) -> NodeBuilder<N, F, V, B, T>

Sets the context the node will execute in.

See State::Context.

source

pub fn traced_by<T: Into<Box<dyn Tracer<InvocationOf<N>>>>>(
self,
tracer: T
) -> Self

Tracer to record events with.

source

pub fn voting_with<T>(self, voter: T) -> NodeBuilder<N, F, T, B, C>

Sets the voting strategy to use.

source

pub fn using(self, kit: NodeKit<InvocationOf<N>>) -> Self

Sets the node kit to use.

source

pub async fn spawn(self) -> SpawnResult<N, Error>where
StateOf<N>: State<Context = C> + Send,
C: Send,

Spawns the node into context ().

source

pub async fn spawn_using<E>(self, executor: E) -> ExecutorSpawnResult<N, E, V, B>where
StateOf<N>: State<Context = C>,
E: Executor<InvocationOf<N>, V, B>,

Spawns the node in the given context.

Trait Implementations

source

impl<N, F, V, B> ExtensibleNodeBuilder for NodeBuilder<N, F, V, B>where
 N: NodeImpl + 'static,
 F: Finisher<Node = N>,
 V: Voter<State = StateOf<N>, RoundNum = RoundNumOf<N>, CoordNum = CoordNumOf<N>, Abstain = AbstainOf<N>, Yea = YeaOf<N>, Nay = NayOf<N>>,
 B: Buffer<RoundNum = RoundNumOf<N>, CoordNum = CoordNumOf<N>, Entry = LogEntryOf<N>>,

type Node = N

Node type without decoration applied.

type DecoratedBuilder<D: Decoration<Decorated = N> + 'static> = NodeBuilder<D, DecorationFinisher<D, F>, V, B, ()>

Type of this builder after decoration D is applied.

source

fn decorated_with<D>(
 self,
 arguments: <D as Decoration>::Arguments
) -> Self::DecoratedBuilder<D>where
 D: Decoration<Decorated = N, Invocation = InvocationOf<N>> + 'static,

Adds a decoration to wrap around the resulting node.

Auto Trait Implementations

impl<N, F, V = IndiscriminateVoter<<<N as Node>::Invocation as Invocation>::State, <<N as Node>::Invocation as Invocation>::RoundNum, <<N as Node>::Invocation as Invocation>::CoordNum, <<N as Node>::Invocation as Invocation>::Abstain, <<N as Node>::Invocation as Invocation>::Yea, <<N as Node>::Invocation as Invocation>::Nay>, B = InMemoryBuffer<<<N as Node>::Invocation as Invocation>::RoundNum, <<N as Node>::Invocation as Invocation>::CoordNum, <<<N as Node>::Invocation as Invocation>::State as State>::LogEntry>, C = ()> !RefUnwindSafe for NodeBuilder<N, F, V, B, C>

impl<N, F, V, B, C> Send for NodeBuilder<N, F, V, B, C>where
 B: Send,
 C: Send,
 F: Send,
 V: Send,

impl<N, F, V = IndiscriminateVoter<<<N as Node>::Invocation as Invocation>::State, <<N as Node>::Invocation as Invocation>::RoundNum, <<N as Node>::Invocation as Invocation>::CoordNum, <<N as Node>::Invocation as Invocation>::Abstain, <<N as Node>::Invocation as Invocation>::Yea, <<N as Node>::Invocation as Invocation>::Nay>, B = InMemoryBuffer<<<N as Node>::Invocation as Invocation>::RoundNum, <<N as Node>::Invocation as Invocation>::CoordNum, <<<N as Node>::Invocation as Invocation>::State as State>::LogEntry>, C = ()> !Sync for NodeBuilder<N, F, V, B, C>

impl<N, F, V, B, C> Unpin for NodeBuilder<N, F, V, B, C>where
 B: Unpin,
 C: Unpin,
 F: Unpin,
 V: Unpin,
 <F as Finisher>::Communicator: Unpin,

impl<N, F, V = IndiscriminateVoter<<<N as Node>::Invocation as Invocation>::State, <<N as Node>::Invocation as Invocation>::RoundNum, <<N as Node>::Invocation as Invocation>::CoordNum, <<N as Node>::Invocation as Invocation>::Abstain, <<N as Node>::Invocation as Invocation>::Yea, <<N as Node>::Invocation as Invocation>::Nay>, B = InMemoryBuffer<<<N as Node>::Invocation as Invocation>::RoundNum, <<N as Node>::Invocation as Invocation>::CoordNum, <<<N as Node>::Invocation as Invocation>::State as State>::LogEntry>, C = ()> !UnwindSafe for NodeBuilder<N, F, V, B, C>

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl AutofillBuilderExt for Bwhere
B: ExtensibleNodeBuilder,
::Node: 'static + NodeImpl,

type Node = ::Node

Type of node to be decorated.

type DecoratedBuilder = ::DecoratedBuilder<Autofill<::Node, C>>

Type of builder after Autofill decoration is applied with config C.

source

fn fill_gaps<C>(
 self,
 config: C
) -> ::DecoratedBuilder<C>where
 C: 'static + Config<Node = ::Node>,

Decorates the node with Autofill using the given configuration.

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl CatchUpBuilderExt for Bwhere
B: ExtensibleNodeBuilder,
::Node: 'static + NodeImpl,

type Node = ::Node

type DecoratedBuilder = ::DecoratedBuilder<CatchUp<::Node, C>>

source

fn catch_up<C>(self, config: C) -> ::DecoratedBuilder<C>where
C: 'static + Config<Node = ::Node>,

source

impl<I, B> DelegateBuilderExt for Bwhere
 I: 'static,
 B: ExtensibleNodeBuilder,
 ::Node: 'static + LeadershipAwareNode,

type Node = ::Node

Node type to be decorated.

type DecoratedBuilder = ::DecoratedBuilder<Delegate<::Node, C, I>>

source

fn delegate<C>(
 self,
 config: C
) -> >::DecoratedBuilder<C>where
 C: 'static + Config<Node = >::Node>,

Decorates the node with Delegate using the given configuration.

source

impl EnsureLeadershipBuilderExt for Bwhere
B: ExtensibleNodeBuilder,
::Node: 'static + NodeImpl,

type Node = ::Node

type DecoratedBuilder = ::DecoratedBuilder<EnsureLeadership<::Node, C>>

source

fn ensure_leadership<C>(
 self,
 config: C
) -> ::DecoratedBuilder<C>where
 C: 'static + Config<Node = ::Node>,

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<I, B> HeartbeatsBuilderExt for Bwhere
 I: 'static,
 B: ExtensibleNodeBuilder,
 ::Node: 'static + MaybeLeadershipAwareNode,

type Node = ::Node

Type of node to be decorated.

type DecoratedBuilder = ::DecoratedBuilder<Heartbeats<::Node, C, I>>

Type of builder after Heartbeats decoration is applied with config C. Read more

source

fn send_heartbeats<C>(
 self,
 config: C
) -> >::DecoratedBuilder<C>where
 C: 'static + Config<Node = >::Node>,

Decorates the node with Heartbeats using the given configuration.

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 for Twhere
U: From<T>,

const: unstable · 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 MasterLeasesBuilderExt for Bwhere
B: ExtensibleNodeBuilder,
::Node: 'static + NodeImpl,

type Node = ::Node

type DecoratedBuilder = ::DecoratedBuilder<MasterLeases<::Node, C>>

source

fn maintain_master_lease<C>(
 self,
 communicator_subscription: Subscription<<<<<::Node as Node>::Invocation as Invocation>::State as State>::Node as NodeInfo>::Id>,
 voter_subscription: Subscription<<<<<::Node as Node>::Invocation as Invocation>::State as State>::Node as NodeInfo>::Id>,
 config: C
) -> ::DecoratedBuilder<C>where
 C: 'static + Config<Node = ::Node>,

source

impl TrackLeadershipBuilderExt for Bwhere
B: ExtensibleNodeBuilder,
::Node: 'static + NodeImpl,

type Node = ::Node

type DecoratedBuilder = ::DecoratedBuilder<TrackLeadership<::Node>>

source

fn track_leadership(self) -> ::DecoratedBuilder

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

fn vzip(self) -> V

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

Struct paxakos::node_builder::NodeBuilder

Implementations

pub fn buffering_applied_entries_in<T: Buffer<RoundNum = RoundNumOf<N>, CoordNum = CoordNumOf<N>, Entry = LogEntryOf<N>>>( self, buffer: T) -> NodeBuilder<N, F, V, T, C>

pub fn in_context<T>(self, context: T) -> NodeBuilder<N, F, V, B, T>

pub fn traced_by<T: Into<Box<dyn Tracer<InvocationOf<N>>>>>( self, tracer: T) -> Self

pub fn voting_with<T>(self, voter: T) -> NodeBuilder<N, F, T, B, C>

pub fn using(self, kit: NodeKit<InvocationOf<N>>) -> Self

pub async fn spawn(self) -> SpawnResult<N, Error>where StateOf<N>: State<Context = C> + Send, C: Send,

pub async fn spawn_using<E>(self, executor: E) -> ExecutorSpawnResult<N, E, V, B>where StateOf<N>: State<Context = C>, E: Executor<InvocationOf<N>, V, B>,

Trait Implementations

type Node = N

type DecoratedBuilder<D: Decoration<Decorated = N> + 'static> = NodeBuilder<D, DecorationFinisher<D, F>, V, B, ()>

fn decorated_with<D>( self, arguments: <D as Decoration>::Arguments) -> Self::DecoratedBuilder<D>where D: Decoration<Decorated = N, Invocation = InvocationOf<N>> + 'static,

Auto Trait Implementations

impl<N, F, V, B, C> Send for NodeBuilder<N, F, V, B, C>where B: Send, C: Send, F: Send, V: Send,

impl<N, F, V, B, C> Unpin for NodeBuilder<N, F, V, B, C>where B: Unpin, C: Unpin, F: Unpin, V: Unpin, <F as Finisher>::Communicator: Unpin,

Blanket Implementations

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

fn type_id(&self) -> TypeId

impl<B> AutofillBuilderExt for Bwhere B: ExtensibleNodeBuilder, <B as ExtensibleNodeBuilder>::Node: 'static + NodeImpl,

type Node = <B as ExtensibleNodeBuilder>::Node

type DecoratedBuilder = <B as ExtensibleNodeBuilder>::DecoratedBuilder<Autofill<<B as ExtensibleNodeBuilder>::Node, C>>

fn fill_gaps<C>( self, config: C) -> <B as AutofillBuilderExt>::DecoratedBuilder<C>where C: 'static + Config<Node = <B as AutofillBuilderExt>::Node>,

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

fn borrow(&self) -> &T

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

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

impl<B> CatchUpBuilderExt for Bwhere B: ExtensibleNodeBuilder, <B as ExtensibleNodeBuilder>::Node: 'static + NodeImpl,

type Node = <B as ExtensibleNodeBuilder>::Node

type DecoratedBuilder = <B as ExtensibleNodeBuilder>::DecoratedBuilder<CatchUp<<B as ExtensibleNodeBuilder>::Node, C>>

fn catch_up<C>(self, config: C) -> <B as CatchUpBuilderExt>::DecoratedBuilder<C>where C: 'static + Config<Node = <B as CatchUpBuilderExt>::Node>,

impl<I, B> DelegateBuilderExt<I> for Bwhere I: 'static, B: ExtensibleNodeBuilder, <B as ExtensibleNodeBuilder>::Node: 'static + LeadershipAwareNode<I>,

type Node = <B as ExtensibleNodeBuilder>::Node

type DecoratedBuilder = <B as ExtensibleNodeBuilder>::DecoratedBuilder<Delegate<<B as ExtensibleNodeBuilder>::Node, C, I>>

fn delegate<C>( self, config: C) -> <B as DelegateBuilderExt<I>>::DecoratedBuilder<C>where C: 'static + Config<Node = <B as DelegateBuilderExt<I>>::Node>,

impl<B> EnsureLeadershipBuilderExt for Bwhere B: ExtensibleNodeBuilder, <B as ExtensibleNodeBuilder>::Node: 'static + NodeImpl,

type Node = <B as ExtensibleNodeBuilder>::Node

type DecoratedBuilder = <B as ExtensibleNodeBuilder>::DecoratedBuilder<EnsureLeadership<<B as ExtensibleNodeBuilder>::Node, C>>

fn ensure_leadership<C>( self, config: C) -> <B as EnsureLeadershipBuilderExt>::DecoratedBuilder<C>where C: 'static + Config<Node = <B as EnsureLeadershipBuilderExt>::Node>,

impl<T> From<T> for T

fn from(t: T) -> T

impl<I, B> HeartbeatsBuilderExt<I> for Bwhere I: 'static, B: ExtensibleNodeBuilder, <B as ExtensibleNodeBuilder>::Node: 'static + MaybeLeadershipAwareNode<I>,

type Node = <B as ExtensibleNodeBuilder>::Node

type DecoratedBuilder = <B as ExtensibleNodeBuilder>::DecoratedBuilder<Heartbeats<<B as ExtensibleNodeBuilder>::Node, C, I>>

fn send_heartbeats<C>( self, config: C) -> <B as HeartbeatsBuilderExt<I>>::DecoratedBuilder<C>where C: 'static + Config<Node = <B as HeartbeatsBuilderExt<I>>::Node>,

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<B> MasterLeasesBuilderExt for Bwhere B: ExtensibleNodeBuilder, <B as ExtensibleNodeBuilder>::Node: 'static + NodeImpl,

type Node = <B as ExtensibleNodeBuilder>::Node

type DecoratedBuilder = <B as ExtensibleNodeBuilder>::DecoratedBuilder<MasterLeases<<B as ExtensibleNodeBuilder>::Node, C>>

impl<B> TrackLeadershipBuilderExt for Bwhere B: ExtensibleNodeBuilder, <B as ExtensibleNodeBuilder>::Node: 'static + NodeImpl,

type Node = <B as ExtensibleNodeBuilder>::Node

type DecoratedBuilder = <B as ExtensibleNodeBuilder>::DecoratedBuilder<TrackLeadership<<B as ExtensibleNodeBuilder>::Node>>

fn track_leadership(self) -> <B as TrackLeadershipBuilderExt>::DecoratedBuilder

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

type Error = Infallible

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

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

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

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

impl<V, T> VZip<V> for Twhere 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>,

fn with_current_subscriber(self) -> WithDispatch<Self>

pub fn buffering_applied_entries_in<T: Buffer<RoundNum = RoundNumOf<N>, CoordNum = CoordNumOf<N>, Entry = LogEntryOf<N>>>(
self,
buffer: T
) -> NodeBuilder<N, F, V, T, C>

pub fn traced_by<T: Into<Box<dyn Tracer<InvocationOf<N>>>>>(
self,
tracer: T
) -> Self

pub async fn spawn(self) -> SpawnResult<N, Error>where
StateOf<N>: State<Context = C> + Send,
C: Send,

pub async fn spawn_using<E>(self, executor: E) -> ExecutorSpawnResult<N, E, V, B>where
StateOf<N>: State<Context = C>,
E: Executor<InvocationOf<N>, V, B>,

fn decorated_with<D>(
self,
arguments: <D as Decoration>::Arguments
) -> Self::DecoratedBuilder<D>where
D: Decoration<Decorated = N, Invocation = InvocationOf<N>> + 'static,

impl<N, F, V, B, C> Send for NodeBuilder<N, F, V, B, C>where
B: Send,
C: Send,
F: Send,
V: Send,

impl<N, F, V, B, C> Unpin for NodeBuilder<N, F, V, B, C>where
B: Unpin,
C: Unpin,
F: Unpin,
V: Unpin,
<F as Finisher>::Communicator: Unpin,

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

impl<B> AutofillBuilderExt for Bwhere
B: ExtensibleNodeBuilder,
<B as ExtensibleNodeBuilder>::Node: 'static + NodeImpl,

fn fill_gaps<C>(
self,
config: C
) -> <B as AutofillBuilderExt>::DecoratedBuilder<C>where
C: 'static + Config<Node = <B as AutofillBuilderExt>::Node>,

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

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

impl<B> CatchUpBuilderExt for Bwhere
B: ExtensibleNodeBuilder,
<B as ExtensibleNodeBuilder>::Node: 'static + NodeImpl,

fn catch_up<C>(self, config: C) -> <B as CatchUpBuilderExt>::DecoratedBuilder<C>where
C: 'static + Config<Node = <B as CatchUpBuilderExt>::Node>,

impl<I, B> DelegateBuilderExt<I> for Bwhere
I: 'static,
B: ExtensibleNodeBuilder,
<B as ExtensibleNodeBuilder>::Node: 'static + LeadershipAwareNode<I>,

fn delegate<C>(
self,
config: C
) -> <B as DelegateBuilderExt<I>>::DecoratedBuilder<C>where
C: 'static + Config<Node = <B as DelegateBuilderExt<I>>::Node>,

impl<B> EnsureLeadershipBuilderExt for Bwhere
B: ExtensibleNodeBuilder,
<B as ExtensibleNodeBuilder>::Node: 'static + NodeImpl,

fn ensure_leadership<C>(
self,
config: C
) -> <B as EnsureLeadershipBuilderExt>::DecoratedBuilder<C>where
C: 'static + Config<Node = <B as EnsureLeadershipBuilderExt>::Node>,

impl<I, B> HeartbeatsBuilderExt<I> for Bwhere
I: 'static,
B: ExtensibleNodeBuilder,
<B as ExtensibleNodeBuilder>::Node: 'static + MaybeLeadershipAwareNode<I>,

fn send_heartbeats<C>(
self,
config: C
) -> <B as HeartbeatsBuilderExt<I>>::DecoratedBuilder<C>where
C: 'static + Config<Node = <B as HeartbeatsBuilderExt<I>>::Node>,

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

impl<B> MasterLeasesBuilderExt for Bwhere
B: ExtensibleNodeBuilder,
<B as ExtensibleNodeBuilder>::Node: 'static + NodeImpl,

impl<B> TrackLeadershipBuilderExt for Bwhere
B: ExtensibleNodeBuilder,
<B as ExtensibleNodeBuilder>::Node: 'static + NodeImpl,

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

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

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

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