Skip to main content

MockSubscriber

Struct MockSubscriber 

Source
pub struct MockSubscriber<E> {
    _phantom: PhantomData<E>,
}
Expand description

Helper for creating test event streams.

Wraps a list of events into a stream of MockReceivedEvent values and returns ack-checkers alongside so tests can verify acknowledgment.

use arminius_lib_message_bus::{
	Event, ReceivedEvent, mock::MockSubscriber,
};
use futures::StreamExt;
use serde::{Deserialize, Serialize};

#[derive(Clone, Debug, Serialize, Deserialize)]
struct Ping {
	id: u32,
}
impl Event for Ping {
	const SUBJECT: &str = "Ping.v1";
}

let (mut stream, checkers) =
	MockSubscriber::new().create_stream(vec![Ping { id: 1 }]);
while let Some(Ok(event)) = stream.next().await {
	event.ack().await.unwrap();
}
assert!(checkers[0].was_acked());

Fields§

§_phantom: PhantomData<E>

Binds the subscriber to its event type E.

Implementations§

Source§

impl<E: Event + Clone> MockSubscriber<E>

Source

pub fn new() -> Self

Creates a new MockSubscriber.

Source

pub fn create_stream( &self, events: Vec<E>, ) -> (impl Stream<Item = Result<MockReceivedEvent<E>, Error>> + use<E>, Vec<MockReceivedEvent<E>>)

Wraps events into a stream of MockReceivedEvent values.

Returns the stream and a parallel Vec of the same wrapped events so callers can call MockReceivedEvent::was_acked after processing.

Trait Implementations§

Source§

impl<E: Debug> Debug for MockSubscriber<E>

Source§

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

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

impl<E: Default> Default for MockSubscriber<E>

Source§

fn default() -> MockSubscriber<E>

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

Auto Trait Implementations§

§

impl<E> Freeze for MockSubscriber<E>

§

impl<E> RefUnwindSafe for MockSubscriber<E>
where E: RefUnwindSafe,

§

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

§

impl<E> Sync for MockSubscriber<E>
where E: Sync,

§

impl<E> Unpin for MockSubscriber<E>
where E: Unpin,

§

impl<E> UnsafeUnpin for MockSubscriber<E>

§

impl<E> UnwindSafe for MockSubscriber<E>
where E: UnwindSafe,

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.

§

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