Struct hedwig::publish::MockPublisher

pub struct MockPublisher(_);

This is supported on crate feature publish only.

A mock publisher that stores messages in-memory for later verification.

This is useful primarily in tests.

Examples

use hedwig::publish::MockPublisher;
let publisher = MockPublisher::default();
let publisher_view = publisher.clone();

Implementations

impl MockPublisher

pub fn new() -> Self

Create a new mock publisher.

pub fn len(&self) -> usize

Number of messages published into this publisher.

pub fn is_empty(&self) -> bool

Number of messages published into this publisher.

pub fn assert_message_published<T: Into<Topic>>(&self, topic: T, uuid: &Uuid)

Verify that a message was published. This method asserts that the message you expected to be published, was indeed published

Panics if the message was not published.

pub fn messages(&self) -> Messages<'_>

Get a view over the messages that have been published to this publisher

Trait Implementations

impl Clone for MockPublisher

fn clone(&self) -> MockPublisher

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MockPublisher

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

Formats the value using the given formatter.

impl Default for MockPublisher

fn default() -> MockPublisher

Returns the “default value” for a type.

impl Publisher for MockPublisher

type MessageId = Uuid

The identifier for a successfully published message.

type MessageError = Infallible

The error that this publisher returns when publishing of a message fails.

type PublishStream = MockPublishStream

The stream of results that the publish method returns.

fn publish<'a, I>(&self, topic: Topic, messages: I) -> Self::PublishStream where
    I: Iterator<Item = &'a ValidatedMessage> + ExactSizeIterator, 

Publish a batch of messages.