Struct StubRuntime 

pub struct StubRuntime { /* private fields */ }

An implementation of Runtime that returns pre-defined results from a queue. This runtime is primarily intended for testing purposes.

Examples

use candid::Principal;
use ic_canister_runtime::{IcError, Runtime, StubRuntime};

const PRINCIPAL: Principal = Principal::from_slice(&[0x9d, 0xf7, 0x01]);
const METHOD: &str = "method";
const ARGS: (&str,) = ("args",);

let runtime = StubRuntime::new()
    .add_stub_response(1_u64)
    .add_stub_response("two")
    .add_stub_error(IcError::CallPerformFailed);

let result_1: Result<u64, IcError> = runtime
    .update_call(PRINCIPAL, METHOD, ARGS, 0)
    .await;
assert_eq!(result_1, Ok(1_u64));

let result_2: Result<String, IcError> = runtime
    .query_call(PRINCIPAL, METHOD, ARGS)
    .await;
assert_eq!(result_2, Ok("two".to_string()));

let result_3: Result<Option<u128>, IcError> = runtime
    .query_call(PRINCIPAL, METHOD, ARGS)
    .await;
assert_eq!(result_3, Err(IcError::CallPerformFailed));

Implementations

impl StubRuntime

pub fn new() -> Self

Create a new empty StubRuntime.

pub fn add_stub_response<Out: CandidType>(self, stub_response: Out) -> Self

Mutate the StubRuntime instance to add the given stub response.

Panics if the stub response cannot be encoded using Candid.

pub fn add_stub_error(self, stub_error: impl Into<IcError>) -> Self

Mutate the StubRuntime instance to add the given stub error.

Trait Implementations

impl Clone for StubRuntime

fn clone(&self) -> StubRuntime

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StubRuntime

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

Formats the value using the given formatter.

impl Default for StubRuntime

fn default() -> StubRuntime

Returns the “default value” for a type.

impl Runtime for StubRuntime

fn update_call<'life0, 'life1, 'async_trait, In, Out>( &'life0 self, _id: Principal, _method: &'life1 str, _args: In, _cycles: u128, ) -> Pin<Box<dyn Future<Output = Result<Out, IcError>> + Send + 'async_trait>>

where In: ArgumentEncoder + Send + 'async_trait, Out: CandidType + DeserializeOwned + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Defines how asynchronous inter-canister update calls are made.

fn query_call<'life0, 'life1, 'async_trait, In, Out>( &'life0 self, _id: Principal, _method: &'life1 str, _args: In, ) -> Pin<Box<dyn Future<Output = Result<Out, IcError>> + Send + 'async_trait>>

where In: ArgumentEncoder + Send + 'async_trait, Out: CandidType + DeserializeOwned + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Defines how asynchronous inter-canister query calls are made.