Skip to main content

Scenario

Struct Scenario 

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

A ready scenario: an explicit fixture the test holds.

Dropping the scenario tears down anything the harness created for the network (a managed local node is force-killed (SIGKILL) as a backstop); Scenario::stop does the same gracefully and reports teardown errors.

Implementations§

Source§

impl Scenario

Source

pub fn builder(seed: impl Into<String>) -> ScenarioBuilder

Start building a scenario with the given deterministic seed.

Source

pub fn network(&self) -> &Network

Handle onto the network the scenario runs against.

Source

pub fn clock(&self) -> &Clock

The scenario’s virtual clock.

Source

pub async fn run_agents<I>(&self, agents: I) -> Result<ScenarioReport>
where I: IntoIterator<Item = Agent>,

Run a set of agents concurrently, returning once all have finished.

Each agent is assigned a distinct account (by position), its own deterministic random stream, and a mailbox. After every non-panicking agent finishes, returned errors are aggregated in TestkitError::AgentsFailed. An agent panic (for example a failed assertion) propagates immediately.

May be called more than once on the same scenario: each call runs in a fresh nonce namespace, so a later run against the same accounts does not collide with an earlier run’s transactions.

Source

pub async fn stop(self) -> Result<()>

Tear the network down gracefully, reporting any teardown error.

Trait Implementations§

Source§

impl Debug for Scenario

Source§

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

Formats the value using the given formatter. 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> MaybeSend for T
where T: Send,

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> StaticIfNoAlloc for T

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more