Struct TestLog

pub struct TestLog<M: RemoteMessage> { /* private fields */ }

An in-memory log for testing.

Implementations

impl<M: RemoteMessage> TestLog<M>

pub fn new() -> Self

Create a new, empty TestLog.

pub fn new_with_observer(observer: UnboundedSender<(String, M)>) -> Self

Create a new test log that sends all log operations to the provided observer. The observer is sent tuples of (op, message), where op is either “append” or “read”.

Trait Implementations

impl<M: Clone + RemoteMessage> Clone for TestLog<M>

fn clone(&self) -> TestLog<M>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<M: Debug + RemoteMessage> Debug for TestLog<M>

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

Formats the value using the given formatter.

impl<M: RemoteMessage + Clone> MessageLog<M> for TestLog<M>

type Stream<'a> = Iter<IntoIter<Result<(u64, M), MessageLogError>>>

The type of the stream returned from read operations on this log.

fn append<'life0, 'async_trait>( &'life0 mut self, message: M, ) -> Pin<Box<dyn Future<Output = Result<(), MessageLogError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Append a message to a buffer. The appended messages will only be persisted and available to read after calling [flush].

fn flush<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<SeqId, MessageLogError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Flush the appended messages. Return the next sequence id of the last persistent message.

fn append_and_flush<'life0, 'life1, 'async_trait>( &'life0 mut self, message: &'life1 M, ) -> Pin<Box<dyn Future<Output = Result<SeqId, MessageLogError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Directly flush the message. All previously buffered messages will be flushed as well. This convenience method can prevent an additional copy of the message by directly writing to the log.

fn trim<'life0, 'async_trait>( &'life0 mut self, new_start: SeqId, ) -> Pin<Box<dyn Future<Output = Result<(), MessageLogError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Trim the persistent logs before the given [new_start] non-inclusively.

fn read<'life0, 'async_trait>( &'life0 self, seq_id: SeqId, ) -> Pin<Box<dyn Future<Output = Result<Self::Stream<'_>, MessageLogError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Given a sequence id, return a stream of message and sequence id tuples that are persisted after the given sequence id inclusively. The stream will yield errors when streaming messages back if any. It will also yield errors if creating the stream itself fails.

fn read_one<'life0, 'async_trait>( &'life0 self, seq_id: SeqId, ) -> Pin<Box<dyn Future<Output = Result<M, MessageLogError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Read exactly one message from the log. If the log is empty, return an error.