Skip to main content

InMemoryBroker

Struct InMemoryBroker 

Source
pub struct InMemoryBroker<T: Clone + Send + Sync + 'static> { /* private fields */ }
Expand description

An in-memory message broker backed by a tokio::sync::broadcast channel.

Create one broker and hand out producers / consumers via InMemoryBroker::producer and InMemoryBroker::consumer.

Every message sent through the broker is recorded in an internal history so that test assertion helpers can inspect what was published.

Implementations§

Source§

impl<T: Clone + Send + Sync + 'static> InMemoryBroker<T>

Source

pub fn new(capacity: usize) -> Self

Create a broker with the given channel capacity.

Source

pub fn producer(&self) -> InMemoryProducer<T>

Create a producer attached to this broker.

Source

pub fn with_history_limit(capacity: usize, history_limit: usize) -> Self

Create a broker with explicit channel capacity and bounded history limit.

The default InMemoryBroker::new bounds history by channel capacity. Use this constructor when tests need a different history limit.

Source

pub fn consumer(&self) -> InMemoryConsumer<T>

Create a consumer attached to this broker.

Source

pub async fn messages(&self, topic: &str) -> Vec<Message<T>>

Return a clone of all messages published to topic.

Source

pub async fn all_messages(&self) -> Vec<Message<T>>

Return a clone of every message published to any topic.

Source

pub async fn message_count(&self, topic: &str) -> usize

Return the number of messages published to topic.

Source

pub async fn reset(&self)

Clear the recorded message history.

Source

pub async fn create_topic(&self, topic: &str)

Pre-create a topic so that it appears in InMemoryBroker::topic_names.

Source

pub async fn topic_names(&self) -> Vec<String>

Return the sorted set of topic names that have been created or published to.

Trait Implementations§

Source§

impl<T: Clone + Clone + Send + Sync + 'static> Clone for InMemoryBroker<T>

Source§

fn clone(&self) -> InMemoryBroker<T>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug + Clone + Send + Sync + 'static> Debug for InMemoryBroker<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: Clone + Send + Sync + 'static> Default for InMemoryBroker<T>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<T> !RefUnwindSafe for InMemoryBroker<T>

§

impl<T> !UnwindSafe for InMemoryBroker<T>

§

impl<T> Freeze for InMemoryBroker<T>

§

impl<T> Send for InMemoryBroker<T>

§

impl<T> Sync for InMemoryBroker<T>

§

impl<T> Unpin for InMemoryBroker<T>

§

impl<T> UnsafeUnpin for InMemoryBroker<T>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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