Skip to main content

MemoryTransport

Struct MemoryTransport 

Source
pub struct MemoryTransport { /* private fields */ }
Expand description

An in-memory RaftTransport that records outgoing messages.

Instead of delivering anywhere, it appends each message to an outbox that a test harness drains with take and routes to the destination node by hand. This makes message ordering, loss, and partitions something the test controls precisely.

§Examples

use raft_io::{MemoryTransport, RaftTransport, Message, AppendEntries};

let mut tx = MemoryTransport::new();
tx.send(2, Message::AppendEntries(AppendEntries {
    term: 1, leader: 1, prev_log_index: 0, prev_log_term: 0,
    entries: Vec::new(), leader_commit: 0,
})).unwrap();

let pending = tx.take();
assert_eq!(pending[0].0, 2);          // destination
assert!(tx.take().is_empty());        // draining leaves it empty

Implementations§

Source§

impl MemoryTransport

Source

pub fn new() -> Self

Creates an empty transport.

Source

pub fn take(&mut self) -> Vec<(NodeId, Message)>

Removes and returns every queued (destination, message) pair.

§Examples
use raft_io::MemoryTransport;

let mut tx = MemoryTransport::new();
assert!(tx.take().is_empty());
Source

pub fn pending(&self) -> usize

Returns the number of queued messages without draining them.

Trait Implementations§

Source§

impl Clone for MemoryTransport

Source§

fn clone(&self) -> MemoryTransport

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 Debug for MemoryTransport

Source§

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

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

impl Default for MemoryTransport

Source§

fn default() -> MemoryTransport

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

impl RaftTransport for MemoryTransport

Source§

fn send(&mut self, to: NodeId, message: Message) -> Result<()>

Delivers message to node to. Read more

Auto Trait Implementations§

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.

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

impl<E> WithErrorCode<E> for E

Source§

fn with_code(self, code: impl Into<String>) -> CodedError<E>

Attach an error code to an error