Struct paxakos::Shell

source · [−]

pub struct Shell<N: NodeImpl> { /* private fields */ }

Expand description

The Node implementation that’s returned from NodeBuilders.

This Node implementation processes requests from NodeHandles. It delegates to the outermost Decoration, thus giving decorations a chance to intercept.

Trait Implementations

source

impl<N, I> LeadershipAwareNode<(I,)> for Shell<N> where
N: NodeImpl + LeadershipAwareNode,

source

fn lax_leadership(&self) -> &[LeadershipFor<N>]

Leadership as assumed by this node. Read more

source

fn strict_leadership(&self) -> &[LeadershipFor<N>]

Leadership as assumed by this node. Read more

source

impl<N> Node for Shell<N> where
N: NodeImpl,

type Invocation = <N as Node>::Invocation

Parametrization of the paxakos algorithm.

type Shutdown = <N as Node>::Shutdown

Type that will perform graceful shutdown if requsted.

source

fn id(&self) -> NodeIdOf<Self>

This node’s identifier.

source

fn status(&self) -> NodeStatus

Node’s current status.

source

fn participation(&self) -> Participation<RoundNumOf<Self>>

Node’s current mode of participation.

source

fn poll_events(&mut self, cx: &mut Context<'_>) -> Poll<EventFor<Self>>

Polls the node’s event stream. Read more

source

fn handle(&self) -> NodeHandle<Self::Invocation>

Returns a handle for this node. Read more

source

fn prepare_snapshot(&self) -> LocalBoxFuture<'static, SnapshotFor<Self>>

Requests that snapshot of the node’s current state be taken.

source

fn affirm_snapshot(
&self,
snapshot: SnapshotFor<Self>
) -> LocalBoxFuture<'static, Result<(), AffirmSnapshotError>>

Affirms that the given snapshot was written to persistent storage. Read more

source

fn install_snapshot(
&self,
snapshot: SnapshotFor<Self>
) -> LocalBoxFuture<'static, Result<(), InstallSnapshotError>>

Requests that the given snapshot be installed. Read more

source

fn read_stale<F, T>(&self, f: F) -> LocalBoxFuture<'_, Result<T, Disoriented>> where
F: FnOnce(&StateOf<Self>) -> T + Send + 'static,
T: Send + 'static,

Reads the node’s current state. Read more

source

fn append<A, P, R>(
 &self,
 applicable: A,
 args: P
) -> LocalBoxFuture<'_, AppendResultFor<Self, A, R>> where
 A: ApplicableTo<StateOf<Self>> + 'static,
 P: Into<AppendArgs<Self::Invocation, R>>,
 R: RetryPolicy<Invocation = Self::Invocation>,

Appends applicable to the shared log.

source

fn append_static<A, P, R>(
 &self,
 applicable: A,
 args: P
) -> LocalBoxFuture<'static, StaticAppendResultFor<Self, A, R>> where
 A: ApplicableTo<StateOf<Self>> + 'static,
 P: Into<AppendArgs<Self::Invocation, R>>,
 R: RetryPolicy<Invocation = Self::Invocation>,
 R::StaticError: From<ShutDownOr<R::Error>>,

Appends applicable to the shared log.

source

fn shut_down(self) -> Self::Shutdown

Begins a graceful shutdown of this node.

source

fn next_event(&mut self) -> NextEvent<'_, Self>ⓘNotable traits for NextEvent<'a, N>`impl<'a, N> Future for NextEvent<'a, N> where N: Node, type Output = EventFor<N>;`

Returns a future that polls this node for events until the next one is returned. Read more

Auto Trait Implementations

impl<N> !RefUnwindSafe for Shell<N>

impl<N> !Send for Shell<N>

impl<N> !Sync for Shell<N>

impl<N> Unpin for Shell<N> where
N: Unpin,

impl<N> !UnwindSafe for Shell<N>

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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 T where
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<T, U> TryFrom for T where
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 T where
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 T where
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::Shell

Trait Implementations

impl<N, I> LeadershipAwareNode<(I,)> for Shell<N> where N: NodeImpl + LeadershipAwareNode<I>,

fn lax_leadership(&self) -> &[LeadershipFor<N>]

fn strict_leadership(&self) -> &[LeadershipFor<N>]

impl<N> Node for Shell<N> where N: NodeImpl,

type Invocation = <N as Node>::Invocation

type Shutdown = <N as Node>::Shutdown

fn id(&self) -> NodeIdOf<Self>

fn status(&self) -> NodeStatus

fn participation(&self) -> Participation<RoundNumOf<Self>>

fn poll_events(&mut self, cx: &mut Context<'_>) -> Poll<EventFor<Self>>

fn handle(&self) -> NodeHandle<Self::Invocation>

fn prepare_snapshot(&self) -> LocalBoxFuture<'static, SnapshotFor<Self>>

fn affirm_snapshot( &self, snapshot: SnapshotFor<Self>) -> LocalBoxFuture<'static, Result<(), AffirmSnapshotError>>

fn install_snapshot( &self, snapshot: SnapshotFor<Self>) -> LocalBoxFuture<'static, Result<(), InstallSnapshotError>>

fn read_stale<F, T>(&self, f: F) -> LocalBoxFuture<'_, Result<T, Disoriented>> where F: FnOnce(&StateOf<Self>) -> T + Send + 'static, T: Send + 'static,

fn append<A, P, R>( &self, applicable: A, args: P) -> LocalBoxFuture<'_, AppendResultFor<Self, A, R>> where A: ApplicableTo<StateOf<Self>> + 'static, P: Into<AppendArgs<Self::Invocation, R>>, R: RetryPolicy<Invocation = Self::Invocation>,

fn shut_down(self) -> Self::Shutdown

fn next_event(&mut self) -> NextEvent<'_, Self>ⓘNotable traits for NextEvent<'a, N>impl<'a, N> Future for NextEvent<'a, N> where N: Node, type Output = EventFor<N>;

Auto Trait Implementations

impl<N> !RefUnwindSafe for Shell<N>

impl<N> !Send for Shell<N>

impl<N> !Sync for Shell<N>

impl<N> Unpin for Shell<N> where N: Unpin,

impl<N> !UnwindSafe for Shell<N>

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Error = Infallible

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

impl<T, U> TryInto<U> for T where 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 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>,

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<N, I> LeadershipAwareNode<(I,)> for Shell<N> where
N: NodeImpl + LeadershipAwareNode<I>,

impl<N> Node for Shell<N> where
N: NodeImpl,

fn affirm_snapshot(
&self,
snapshot: SnapshotFor<Self>
) -> LocalBoxFuture<'static, Result<(), AffirmSnapshotError>>

fn install_snapshot(
&self,
snapshot: SnapshotFor<Self>
) -> LocalBoxFuture<'static, Result<(), InstallSnapshotError>>

fn read_stale<F, T>(&self, f: F) -> LocalBoxFuture<'_, Result<T, Disoriented>> where
F: FnOnce(&StateOf<Self>) -> T + Send + 'static,
T: Send + 'static,

fn append<A, P, R>(
&self,
applicable: A,
args: P
) -> LocalBoxFuture<'_, AppendResultFor<Self, A, R>> where
A: ApplicableTo<StateOf<Self>> + 'static,
P: Into<AppendArgs<Self::Invocation, R>>,
R: RetryPolicy<Invocation = Self::Invocation>,

fn next_event(&mut self) -> NextEvent<'_, Self>ⓘNotable traits for NextEvent<'a, N>`impl<'a, N> Future for NextEvent<'a, N> where N: Node, type Output = EventFor<N>;`

impl<N> Unpin for Shell<N> where
N: Unpin,

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

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

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

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

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

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

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

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