Skip to main content

MockPublisher

Struct MockPublisher 

Source
pub struct MockPublisher<E> {
    published: Arc<Mutex<Vec<E>>>,
}
Expand description

In-memory Publisher for use in unit tests.

Captures all published events so tests can assert on what was published without needing a running NATS server.

MockPublisher<E> can only capture events of exactly type E. To capture multiple event types in one publisher, wrap them in an enum or use MockBus.

§Example

use arminius_lib_message_bus::{Event, Publisher, mock::MockPublisher};
use serde::{Deserialize, Serialize};

#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
struct RoomCreated {
	room_id: String,
}

impl Event for RoomCreated {
	const SUBJECT: &str = "RoomCreated.v1";
}

let publisher: MockPublisher<RoomCreated> = MockPublisher::new();
publisher.publish(RoomCreated { room_id: "!abc".into() }).await.unwrap();
assert_eq!(publisher.published_messages().len(), 1);

Fields§

§published: Arc<Mutex<Vec<E>>>

All events published so far, in order.

Implementations§

Source§

impl<E: Clone> MockPublisher<E>

Source

pub fn new() -> Self

Creates a new empty MockPublisher.

Source

pub fn published_messages(&self) -> Vec<E>

Returns a snapshot of all events published so far, in order.

Trait Implementations§

Source§

impl<E: Clone> Clone for MockPublisher<E>

Source§

fn clone(&self) -> MockPublisher<E>

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<E: Debug> Debug for MockPublisher<E>

Source§

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

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

impl<E: Default> Default for MockPublisher<E>

Source§

fn default() -> MockPublisher<E>

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

impl<T> Publisher for MockPublisher<T>
where T: Event + Clone + 'static,

Source§

async fn publish<E>(&self, message: E) -> Result<(), Error>
where E: Event + Clone + 'static,

Publish an event to its subject. Read more

Auto Trait Implementations§

§

impl<E> Freeze for MockPublisher<E>

§

impl<E> RefUnwindSafe for MockPublisher<E>

§

impl<E> Send for MockPublisher<E>
where E: Send,

§

impl<E> Sync for MockPublisher<E>
where E: Send,

§

impl<E> Unpin for MockPublisher<E>

§

impl<E> UnsafeUnpin for MockPublisher<E>

§

impl<E> UnwindSafe for MockPublisher<E>

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.

§

impl<T> FutureExt for T

§

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

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

fn with_current_context(self) -> WithContext<Self>

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

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more