Struct paxakos::NodeHandle

source · [−]

pub struct NodeHandle<I: Invocation> { /* private fields */ }

Expand description

A remote handle for a paxakos Node.

Implementations

source

impl<I: Invocation> NodeHandle

source

pub fn status(&self) -> impl Future<Output = Result<NodeStatus, ShutDown>>

Node’s current status.

source

pub fn prepare_snapshot(
&self
) -> impl Future<Output = Result<SnapshotFor, ShutDown>>

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

source

pub fn affirm_snapshot(
&self,
snapshot: SnapshotFor
) -> impl Future<Output = Result<(), AffirmSnapshotError>>

Affirms that the given snapshot was written to persistent storage.

Currently does nothing.

source

pub fn install_snapshot(
&self,
snapshot: SnapshotFor
) -> impl Future<Output = Result<(), InstallSnapshotError>>

Requests that the given snapshot be installed.

See Node::install_snapshot.

source

pub fn read_stale<F, T>(
 &self,
 f: F
) -> impl Future<Output = Result<T, ReadStaleError>> where
 F: FnOnce(&StateOf) -> T + Send + 'static,
 T: Send + 'static,

Reads the node’s current state.

As the name implies the state may be stale, i.e. other node’s may have advanced the shared state without this node being aware.

source

pub fn append<A, P, R>(
 &self,
 applicable: A,
 args: P
) -> impl Future<Output = Result<CommitFor<I, A>, R::StaticError>> where
 A: ApplicableTo<StateOf>,
 P: Into<AppendArgs<I, R>>,
 R: RetryPolicy<Invocation = I> + Send + 'static,
 R::Error: Send,
 R::StaticError: From<ShutDownOr<R::Error>>,
 R::Future: Send,

Appends applicable to the shared log.

Trait Implementations

source

impl<I: Invocation> Admin for NodeHandle

source

fn force_active(&self) -> BoxFuture<'static, Result<bool, ShutDown>>

Forces node out of passive participation. Read more

source

impl<I: Invocation> Clone for NodeHandle

source

fn clone(&self) -> Self

Returns a copy of the value. Read more

1.0.0 · source

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

source

impl<I: Invocation> Debug for NodeHandle

source

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl !RefUnwindSafe for NodeHandle

impl Send for NodeHandle

impl Sync for NodeHandle

impl Unpin for NodeHandle

impl !UnwindSafe for NodeHandle

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<S> Frozen<S> for S where
S: Clone,

source

fn thaw(&self) -> S

Thaws this value.

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> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

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::NodeHandle

Implementations

impl<I: Invocation> NodeHandle<I>

pub fn status(&self) -> impl Future<Output = Result<NodeStatus, ShutDown>>

pub fn prepare_snapshot( &self) -> impl Future<Output = Result<SnapshotFor<I>, ShutDown>>

pub fn affirm_snapshot( &self, snapshot: SnapshotFor<I>) -> impl Future<Output = Result<(), AffirmSnapshotError>>

pub fn install_snapshot( &self, snapshot: SnapshotFor<I>) -> impl Future<Output = Result<(), InstallSnapshotError>>

pub fn read_stale<F, T>( &self, f: F) -> impl Future<Output = Result<T, ReadStaleError>> where F: FnOnce(&StateOf<I>) -> T + Send + 'static, T: Send + 'static,

Trait Implementations

impl<I: Invocation> Admin for NodeHandle<I>

fn force_active(&self) -> BoxFuture<'static, Result<bool, ShutDown>>

impl<I: Invocation> Clone for NodeHandle<I>

fn clone(&self) -> Self

fn clone_from(&mut self, source: &Self)

impl<I: Invocation> Debug for NodeHandle<I>

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

Auto Trait Implementations

impl<I> !RefUnwindSafe for NodeHandle<I>

impl<I> Send for NodeHandle<I>

impl<I> Sync for NodeHandle<I>

impl<I> Unpin for NodeHandle<I>

impl<I> !UnwindSafe for NodeHandle<I>

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<S> Frozen<S> for S where S: Clone,

fn thaw(&self) -> S

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> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

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>

pub fn prepare_snapshot(
&self
) -> impl Future<Output = Result<SnapshotFor<I>, ShutDown>>

pub fn affirm_snapshot(
&self,
snapshot: SnapshotFor<I>
) -> impl Future<Output = Result<(), AffirmSnapshotError>>

pub fn install_snapshot(
&self,
snapshot: SnapshotFor<I>
) -> impl Future<Output = Result<(), InstallSnapshotError>>

pub fn read_stale<F, T>(
&self,
f: F
) -> impl Future<Output = Result<T, ReadStaleError>> where
F: FnOnce(&StateOf<I>) -> T + Send + 'static,
T: Send + 'static,

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<S> Frozen<S> for S where
S: Clone,

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

impl<T> ToOwned for T where
T: Clone,

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>,