Struct Engine

Source

pub struct Engine<E: Clock + GClock + Rng + CryptoRng + Spawner + Storage + Metrics, C: Signer, B: Blocker<PublicKey = C::PublicKey>, V: Variant, D: Digest, A: Automaton<Context = Context<D>, Digest = D>, R: Relay<Digest = D>, F: Reporter<Activity = Activity<V, D>>, S: ThresholdSupervisor<Index = View, PublicKey = C::PublicKey, Identity = V::Public, Seed = V::Signature, Polynomial = Vec<V::Public>, Share = Share>> { /* private fields */ }

Expand description

Instance of threshold-simplex consensus engine.

Implementations§

Source §

impl<E: Clock + GClock + Rng + CryptoRng + Spawner + Storage + Metrics, C: Signer, B: Blocker<PublicKey = C::PublicKey>, V: Variant, D: Digest, A: Automaton<Context = Context<D>, Digest = D>, R: Relay<Digest = D>, F: Reporter<Activity = Activity<V, D>>, S: ThresholdSupervisor<Seed = V::Signature, Index = View, Share = Share, Polynomial = Vec<V::Public>, Identity = V::Public, PublicKey = C::PublicKey>> Engine<E, C, B, V, D, A, R, F, S>

Source

pub fn new(context: E, cfg: Config<C, B, V, D, A, R, F, S>) -> Self

Create a new threshold-simplex consensus engine.

Source

pub fn start( self, pending_network: (impl Sender<PublicKey = C::PublicKey>, impl Receiver<PublicKey = C::PublicKey>), recovered_network: (impl Sender<PublicKey = C::PublicKey>, impl Receiver<PublicKey = C::PublicKey>), resolver_network: (impl Sender<PublicKey = C::PublicKey>, impl Receiver<PublicKey = C::PublicKey>), ) -> Handle<()>

Start the threshold-simplex consensus engine.

This will also rebuild the state of the engine from provided Journal.

Auto Trait Implementations§

§

impl<E, C, B, V, D, A, R, F, S> !Freeze for Engine<E, C, B, V, D, A, R, F, S>

§

impl<E, C, B, V, D, A, R, F, S> !RefUnwindSafe for Engine<E, C, B, V, D, A, R, F, S>

§

impl<E, C, B, V, D, A, R, F, S> Send for Engine<E, C, B, V, D, A, R, F, S>

§

impl<E, C, B, V, D, A, R, F, S> Sync for Engine<E, C, B, V, D, A, R, F, S>
where B: Sync, A: Sync, R: Sync, F: Sync,

§

impl<E, C, B, V, D, A, R, F, S> Unpin for Engine<E, C, B, V, D, A, R, F, S>
where E: Unpin, C: Unpin, B: Unpin, A: Unpin, R: Unpin, F: Unpin, S: Unpin, D: Unpin, <C as Signer>::PublicKey: Unpin, <E as Clock>::Instant: Unpin, <V as Variant>::Signature: Unpin,

§

impl<E, C, B, V, D, A, R, F, S> !UnwindSafe for Engine<E, C, B, V, D, A, R, F, S>

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

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T> FutureExt for T

Source §

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

Source §

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext 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 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

Source §

impl<T> Pointable for T

Source §

const ALIGN: usize

The alignment of pointer.

Source §

type Init = T

The type for initializers.

Source §

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

Initializes a with the given initializer. Read more

Source §

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

Dereferences the given pointer. Read more

Source §

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

Mutably dereferences the given pointer. Read more

Source §

unsafe fn drop(ptr: usize)

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

Source §

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

Source §

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

Source §

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

Source §

type Output = T

Should always be Self

Source §

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

Source §

type Error = Infallible

The type returned in the event of a conversion error.

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

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

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

Performs the conversion.

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

Source §

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

Source §

Struct EngineCopy item path

Implementations§

pub fn new(context: E, cfg: Config<C, B, V, D, A, R, F, S>) -> Self

Auto Trait Implementations§

impl<E, C, B, V, D, A, R, F, S> !Freeze for Engine<E, C, B, V, D, A, R, F, S>

impl<E, C, B, V, D, A, R, F, S> !RefUnwindSafe for Engine<E, C, B, V, D, A, R, F, S>

impl<E, C, B, V, D, A, R, F, S> Send for Engine<E, C, B, V, D, A, R, F, S>

impl<E, C, B, V, D, A, R, F, S> Sync for Engine<E, C, B, V, D, A, R, F, S>where B: Sync, A: Sync, R: Sync, F: Sync,

impl<E, C, B, V, D, A, R, F, S> Unpin for Engine<E, C, B, V, D, A, R, F, S>where E: Unpin, C: Unpin, B: Unpin, A: Unpin, R: Unpin, F: Unpin, S: Unpin, D: Unpin, <C as Signer>::PublicKey: Unpin, <E as Clock>::Instant: Unpin, <V as Variant>::Signature: Unpin,

impl<E, C, B, V, D, A, R, F, S> !UnwindSafe for Engine<E, C, B, V, D, A, R, F, S>

Blanket Implementations§

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

fn type_id(&self) -> TypeId

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<T> From<T> for T

fn from(t: T) -> T

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self>

fn with_current_context(self) -> WithContext<Self>

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<T> IntoEither for T

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

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

impl<T> Pointable for T

const ALIGN: usize

type Init = T

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

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

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

unsafe fn drop(ptr: usize)

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

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

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

impl<T> Same for T

type Output = T

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>

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

impl<A, B, T> HttpServerConnExec<A, B> for Twhere B: Body,

Struct Engine

impl<E, C, B, V, D, A, R, F, S> Sync for Engine<E, C, B, V, D, A, R, F, S>
where B: Sync, A: Sync, R: Sync, F: Sync,

impl<E, C, B, V, D, A, R, F, S> Unpin for Engine<E, C, B, V, D, A, R, F, S>
where E: Unpin, C: Unpin, B: Unpin, A: Unpin, R: Unpin, F: Unpin, S: Unpin, D: Unpin, <C as Signer>::PublicKey: Unpin, <E as Clock>::Instant: Unpin, <V as Variant>::Signature: 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>,

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

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

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

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

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

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,