Struct TestPlatform 

pub struct TestPlatform<T = ()> { /* private fields */ }

Available on crate feature testing only.

A Platform for tests: REST goes to a MockTransport, Background Work waits until run_background, and Bot Data (T) is whatever the test gives. Clones share everything, like an Adapter’s State.

For a bot’s own traits (a key-value store, say), implement them on TestPlatform<YourData> in the bot’s crate, or, from an integration test (where the orphan rule forbids that), on a newtype that forwards Platform and HasData to a TestPlatform.

Implementations

impl TestPlatform

pub fn new() -> Self

No Bot Data, the bot token bot-token, and a MockTransport answering 200 {}

impl<T> TestPlatform<T>

pub fn with_data<U>(self, data: U) -> TestPlatform<U>

With data as Bot Data (HasData)

pub fn with_bot_token(self, token: Option<&str>) -> Self

With token as the bot token, or none (ctx.bot() then fails)

pub fn with_transport(self, transport: MockTransport) -> Self

With transport answering REST requests

pub fn transport(&self) -> &MockTransport

The Transport, to read the requests sent

pub fn queued_work(&self) -> usize

How much Background Work is waiting to run

pub fn run_all(&self) -> Vec<Result<(), HandlerError>>

Runs the waiting Background Work in order, as wait_until or a spawned task would after the response is sent, then any it spawns in turn, until none is left; every result

pub fn run_background(&self) -> Result<(), HandlerError>

run_all, failing with the first error

Trait Implementations

impl<T> Clone for TestPlatform<T>

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 TestPlatform

fn default() -> Self

Returns the “default value” for a type.

impl<T: Send + Sync> HasData for TestPlatform<T>

type Data = T

The Bot Data

fn data(&self) -> &T

The Bot Data

impl<T: Send + Sync + 'static> Platform for TestPlatform<T>

type Transport = Arc<MockTransport>

Available on crate feature rest only.

The HTTP client REST calls go through

fn transport(&self) -> Arc<MockTransport>

Available on crate feature rest only.

A handle to the Transport, for a new client

fn spawn(&self, work: BackgroundWork)

Available on crate feature rest only.

Runs work after the response is sent (wait_until on Cloudflare, tokio::spawn on a hosted server), within the platform’s post-response time limit

fn bot_token(&self) -> Option<&str>

Available on crate feature rest only.

The bot token (DISCORD_TOKEN), without the Bot prefix