Struct ic_kit::Method

pub struct Method { /* fields omitted */ }

A method that is constructed using nested calls.

Implementations

impl Method

pub const fn new() -> Self

Create a new method.

pub fn name<S: Into<String>>(self, name: S) -> Self

Put a name for the method. Setting a name on the method makes the CallHandler for this method skip this method if it’s trying to make a call to a method with a different name.

Panics

If the method already has a name.

pub fn cycles_consume_all(self) -> Self

Make the method consume all of the cycles provided to it.

pub fn cycles_consume(self, cycles: u64) -> Self

Make the method consume at most the given amount of cycles.

pub fn cycles_refund(self, cycles: u64) -> Self

Make the method refund the given amount of cycles.

pub fn expect_arguments<T: ArgumentEncoder>(self, arguments: T) -> Self

Make the method expect the given value as the argument, this method makes the method panic if it’s called with an argument other than what is provided.

Panics

If called more than once.

pub fn expect_cycles(self, cycles: u64) -> Self

Create a method that expects this amount of cycles to be sent to it.

Panics

If called more than once on a method.

pub fn response<T: CandidType>(self, value: T) -> Self

Make the method return the given constant value every time.

Panics

If called more than once.

Trait Implementations

impl CallHandler for Method

fn accept(&self, _: &Principal, method: &str) -> bool

Whatever the handler can handle the given call or not, if this method returns false, we skip this handler and try to find the next handler that can handle the call.

fn perform(
    &self,
    _caller: &Principal,
    cycles: u64,
    _canister_id: &Principal,
    _method: &str,
    args_raw: &Vec<u8>,
    ctx: Option<&mut MockContext>
) -> (CallResult<Vec<u8>>, u64)

Perform the call using this handler. Only called if accept() first returned true.