Struct TestNetDirProvider

pub struct TestNetDirProvider { /* private fields */ }

Available on crate feature testing only.

Helper implementation of a NetDirProvider.

A TestNetDirProvider can be used to provide a netdir in a single situation that requires a NetDirProvider.

It notifies its owner of changes by firing a NewConsensus event each time TestNetDirProvider::set_netdir_and_notify is called.

Calling TestNetDirProvider::set_netdir will not trigger a notification.

Implementations

impl TestNetDirProvider

pub fn new() -> Self

Create a new TestNetDirProvider with no netdir available.

pub fn set_netdir(&self, dir: impl Into<Arc<NetDir>>)

Replace the NetDir in this TestNetDirProvider.

pub async fn set_netdir_and_notify(&self, dir: impl Into<Arc<NetDir>>)

Replace the NetDir in this TestNetDirProvider, firing a NewConsensus event.

Trait Implementations

impl Debug for TestNetDirProvider

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

Formats the value using the given formatter.

impl From<NetDir> for TestNetDirProvider

fn from(nd: NetDir) -> Self

Converts to this type from the input type.

impl NetDirProvider for TestNetDirProvider

fn netdir(&self, _timeliness: Timeliness) -> Result<Arc<NetDir>>

Return a network directory that’s live according to the provided timeliness.

fn events(&self) -> BoxStream<'static, DirEvent>

Return a new asynchronous stream that will receive notification whenever the consensus has changed.

fn params(&self) -> Arc<dyn AsRef<NetParameters>>

Return the latest network parameters.

fn timely_netdir(&self) -> Result<Arc<NetDir>>

Return a reasonable netdir for general usage.

fn wait_for_netdir<'life0, 'async_trait>( &'life0 self, timeliness: Timeliness, ) -> Pin<Box<dyn Future<Output = Result<Arc<NetDir>, NetdirProviderShutdown>> + Send + 'async_trait>>

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

Get a NetDir from provider, waiting until one exists.

fn wait_for_netdir_to_list<'life0, 'life1, 'async_trait>( &'life0 self, target: &'life1 RelayIds, timeliness: Timeliness, ) -> Pin<Box<dyn Future<Output = Result<(), NetdirProviderShutdown>> + Send + 'async_trait>>

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

Wait until provider lists target.