CallBuilder

Struct CallBuilder 

Source
pub struct CallBuilder<R: for<'a> Deserialize<'a> + CandidType, P: Provider> {
    pub provider: P,
    pub canister_id: Principal,
    pub call_mode: CallMode,
    pub method: String,
    pub args: Result<Vec<u8>, Error>,
    pub _result: PhantomData<R>,
}
Expand description

A builder for creating and executing canister method calls in tests.

Generic over:

  • R: The expected result type of the method.
  • P: The provider type (e.g., IcpUser or PocketIC).

Fields§

§provider: P

The test environment provider.

§canister_id: Principal

The principal of the canister to call.

§call_mode: CallMode

The mode of the call (query or update).

§method: String

The name of the method being called.

§args: Result<Vec<u8>, Error>

Candid-encoded call arguments, or an encoding error.

§_result: PhantomData<R>

Phantom type to carry the result type without storing it.

Implementations§

Source§

impl<R: for<'a> Deserialize<'a> + CandidType, P: Provider> CallBuilder<R, P>

Source

pub fn with_caller<C: Caller>(self, caller: C) -> CallBuilder<R, C::Provider>

Setup caller of the bulider

Source

pub fn with_update(self) -> Self

Switch caller mode to update

Source

pub async fn maybe_call(self) -> Result<R, CallError>

Execute the call and returns a Result with decoded output or CallError.

§Errors

Returns a CallError if encoding, calling, or decoding fails.

Source

pub async fn call(self) -> R

Execute the call assuming there is no error ().

Auto Trait Implementations§

§

impl<R, P> Freeze for CallBuilder<R, P>
where P: Freeze,

§

impl<R, P> RefUnwindSafe for CallBuilder<R, P>

§

impl<R, P> Send for CallBuilder<R, P>
where P: Send, R: Send,

§

impl<R, P> Sync for CallBuilder<R, P>
where P: Sync, R: Sync,

§

impl<R, P> Unpin for CallBuilder<R, P>
where P: Unpin, R: Unpin,

§

impl<R, P> UnwindSafe for CallBuilder<R, P>
where P: UnwindSafe, R: UnwindSafe,

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<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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> SendSyncUnwindSafe for T
where T: Send + Sync + UnwindSafe + ?Sized,