IcpUser

Struct IcpUser 

Source
pub struct IcpUser {
    pub principal: Principal,
    /* private fields */
}
Expand description

A simulated Internet Computer user for use in tests.

Provides a simplified API for calling methods and deploying canisters. Wraps a Principal identity and a reference to the PocketIc test environment.

Fields§

§principal: Principal

The user’s principal identity used for calls and deployments.

Implementations§

Source§

impl IcpUser

Source

pub fn call<ResultType>( &self, canister_id: Principal, call_mode: CallMode, method: &str, args: Result<Vec<u8>, Error>, ) -> CallBuilder<ResultType, Self>
where ResultType: for<'a> Deserialize<'a> + CandidType,

Prepare a canister method call builder for the user.

§Parameters
  • canister_id: The principal ID of the target canister.
  • call_mode: Whether the call is a query or an update.
  • method: The name of the method to invoke.
  • args: Encoded Candid arguments or an error.
§Returns

A CallBuilder for the specified method, result type, and context.

Source

pub fn deploy<Canister>( &self, args: Result<Vec<u8>, Error>, new: fn(&Self, Principal) -> Canister, ) -> DeployBuilder<Canister, Self>

Prepare a new canister deployment as this user.

§Parameters
  • args: Encoded Candid arguments for the canister constructor, or an error.
  • new: A function to instantiate the canister wrapper after deployment.
§Returns

A DeployBuilder for the specified canister.

Trait Implementations§

Source§

impl Caller for IcpUser

Source§

fn call<ResultType>( &self, canister_id: Principal, call_mode: CallMode, method: &str, args: Result<Vec<u8>, Error>, ) -> CallBuilder<ResultType, Self::Provider>
where ResultType: for<'a> Deserialize<'a> + CandidType,

Dispatch a call via this user, required by the Caller trait.

Source§

type Provider = IcpUser

Source§

impl Clone for IcpUser

Source§

fn clone(&self) -> IcpUser

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Deployer for IcpUser

Source§

fn deploy<Canister>( &self, args: Result<Vec<u8>, Error>, new: fn(&Self::Caller, Principal) -> Canister, ) -> DeployBuilder<Canister, Self::Caller>

Dispatch a deployment via this user, required by the Deployer trait.

Source§

type Caller = IcpUser

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> TryClone for T
where T: Clone,

Source§

fn try_clone(&self) -> Result<T, Error>

Clones self, possibly returning an error.
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,