Mailbox

commonware_broadcast::buffered

Struct Mailbox 

Source 
pub struct Mailbox<P: PublicKey, M: Committable + Digestible + Codec> { /* private fields */ }
Expand description

Ingress mailbox for super::Engine.

Implementations§

Source§

impl<P: PublicKey, M: Committable + Digestible + Codec> Mailbox<P, M>

Source

pub async fn subscribe( &mut self, peer: Option<P>, commitment: M::Commitment, digest: Option<M::Digest>, ) -> Receiver<M>

Subscribe to a message by peer (optionally), commitment, and digest (optionally).

The responder will be sent the first message for an commitment when it is available; either instantly (if cached) or when it is received from the network. The request can be canceled by dropping the responder.

Source

pub async fn subscribe_prepared( &mut self, peer: Option<P>, commitment: M::Commitment, digest: Option<M::Digest>, responder: Sender<M>, )

Subscribe to a message by peer (optionally), commitment, and digest (optionally) with an externally prepared responder.

The responder will be sent the first message for an commitment when it is available; either instantly (if cached) or when it is received from the network. The request can be canceled by dropping the responder.

Source

pub async fn get( &mut self, peer: Option<P>, commitment: M::Commitment, digest: Option<M::Digest>, ) -> Vec<M>

Get all messages for an commitment.

Trait Implementations§

Source§

impl<P: PublicKey, M: Committable + Digestible + Codec> Broadcaster for Mailbox<P, M>

Source§

type Recipients = Recipients<P>

The type of recipients that can receive messages.
Source§

type Message = M

Message is the type of data that can be broadcasted. Read more
Source§

type Response = Vec<P>

The type of data that is returned once the message is broadcasted. Read more
Source§

async fn broadcast( &mut self, recipients: Self::Recipients, message: Self::Message, ) -> Receiver<Self::Response>

Attempt to broadcast a message to the associated recipients.
Source§

impl<P: Clone + PublicKey, M: Clone + Committable + Digestible + Codec> Clone for Mailbox<P, M>

Source§

fn clone(&self) -> Mailbox<P, M>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<P, M> Freeze for Mailbox<P, M>

§

impl<P, M> !RefUnwindSafe for Mailbox<P, M>

§

impl<P, M> Send for Mailbox<P, M>

§

impl<P, M> Sync for Mailbox<P, M>

§

impl<P, M> Unpin for Mailbox<P, M>

§

impl<P, M> !UnwindSafe for Mailbox<P, M>

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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<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
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> ToOwned for T
where T: Clone,

Source§

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)

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

impl<T, U> TryFrom<U> 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<U>>::Error>

Performs the conversion.
Source§

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

Source§

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.
Source§

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

Source§

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
Source§

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