Struct Context

pub struct Context { /* private fields */ }

Implementation of crate::Spawner, crate::Clock, crate::Network, and crate::Storage for the deterministic runtime.

Implementations

impl Context

pub fn new(cfg: Config) -> Self

pub fn recover(self) -> Self

Recover the inner state (deadline, metrics, auditor, rng, synced storage, etc.) from the current runtime and use it to initialize a new instance of the runtime. A recovered runtime does not inherit the current runtime’s pending tasks, unsynced storage, network connections, nor its shutdown signaler.

This is useful for performing a deterministic simulation that spans multiple runtime instantiations, like simulating unclean shutdown (which involves repeatedly halting the runtime at unexpected intervals).

It is only permitted to call this method after the runtime has finished (i.e. once start returns) and only permitted to do once (otherwise multiple recovered runtimes will share the same inner state). If either one of these conditions is violated, this method will panic.

pub fn auditor(&self) -> &Auditor

Trait Implementations

impl Clock for Context

fn current(&self) -> SystemTime

Returns the current time.

fn sleep(&self, duration: Duration) -> impl Future<Output = ()> + Send + 'static

Sleep for the given duration.

fn sleep_until( &self, deadline: SystemTime, ) -> impl Future<Output = ()> + Send + 'static

Sleep until the given deadline.

impl Clock for Context

type Instant = SystemTime

A measurement of a monotonically increasing clock.

fn now(&self) -> Self::Instant

Returns a measurement of the clock.

impl Clone for Context

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Context

fn default() -> Self

Returns the “default value” for a type.

impl From<Context> for Runner

fn from(context: Context) -> Self

Converts to this type from the input type.

impl Metrics for Context

fn with_label(&self, label: &str) -> Self

Create a new instance of Metrics with the given label appended to the end of the current Metrics label.

fn label(&self) -> String

Get the current label of the context.

fn register<N: Into<String>, H: Into<String>>( &self, name: N, help: H, metric: impl Metric, )

Register a metric with the runtime.

fn encode(&self) -> String

Encode all metrics into a buffer.

fn scoped_label(&self, label: &str) -> String

Prefix the given label with the current context’s label.

impl Network for Context

type Listener = <Network<Network<Network>> as Network>::Listener

The type of Listener that’s returned when binding to a socket. Accepting a connection returns a Sink and Stream which are defined by the Listener and used to send and receive data over the connection.

async fn bind(&self, socket: SocketAddr) -> Result<Self::Listener, Error>

Bind to the given socket address.

async fn dial( &self, socket: SocketAddr, ) -> Result<(SinkOf<Self>, StreamOf<Self>), Error>

Dial the given socket address.

impl ReasonablyRealtime for Context

fn reference_point(&self) -> Self::Instant

Returns a reference point at the start of an operation.

impl RngCore for Context

fn next_u32(&mut self) -> u32

Return the next random u32.

fn next_u64(&mut self) -> u64

Return the next random u64.

fn fill_bytes(&mut self, dest: &mut [u8])

Fill dest with random data.

fn try_fill_bytes(&mut self, dest: &mut [u8]) -> Result<(), Error>

Fill dest entirely with random data.

impl Spawner for Context

fn spawn<F, Fut, T>(self, f: F) -> Handle<T>

where F: FnOnce(Self) -> Fut + Send + 'static, Fut: Future<Output = T> + Send + 'static, T: Send + 'static,

Enqueue a task to be executed.

fn spawn_ref<F, T>(&mut self) -> impl FnOnce(F) -> Handle<T> + 'static

where F: Future<Output = T> + Send + 'static, T: Send + 'static,

Enqueue a task to be executed (without consuming the context).

fn spawn_blocking<F, T>(self, dedicated: bool, f: F) -> Handle<T>

where F: FnOnce(Self) -> T + Send + 'static, T: Send + 'static,

Enqueue a blocking task to be executed.

fn spawn_blocking_ref<F, T>( &mut self, dedicated: bool, ) -> impl FnOnce(F) -> Handle<T> + 'static

where F: FnOnce() -> T + Send + 'static, T: Send + 'static,

Enqueue a blocking task to be executed (without consuming the context).

fn stop(&self, value: i32)

Signals the runtime to stop execution and that all outstanding tasks should perform any required cleanup and exit. This method is idempotent and can be called multiple times.

fn stopped(&self) -> Signal

Returns an instance of a Signal that resolves when stop is called by any task.

impl Storage for Context

type Blob = <Storage<Storage<Storage>> as Storage>::Blob

The readable/writeable storage buffer that can be opened by this Storage.

async fn open( &self, partition: &str, name: &[u8], ) -> Result<(Self::Blob, u64), Error>

Open an existing blob in a given partition or create a new one, returning the blob and its length.

async fn remove( &self, partition: &str, name: Option<&[u8]>, ) -> Result<(), Error>

Remove a blob from a given partition.

async fn scan(&self, partition: &str) -> Result<Vec<Vec<u8>>, Error>

Return all blobs in a given partition.

impl CryptoRng for Context