Module pocket_ic

Expand description

Maintained PocketIC 16.1 client implementation; see ../upstream/NOTICE.md.

Modules§

common: Types that are shared between the PocketIC server and the PocketIC library. This module is a dependency of the server in the IC repository.
nonblocking
snapshot: Bounded native snapshot copying. Callers own funding, custody and recovery.

CanisterLogRecord: Canister Log Record
CanisterSettings: Canister Settings
CanisterStatusResult: Canister Status Result
CreateCanisterParams: Parameters for PocketIc::create_canister_with_params.
EnvironmentVariable: Environment Variable.
ErrorCodeIter: An iterator over the variants of ErrorCode
Operation: A computation accepted by the PocketIC server.
PocketIc: Main entry point for interacting with PocketIC.
PocketIcBuilder
PocketIcState
RejectCodeIter: An iterator over the variants of RejectCode
RejectResponse: User-facing type describing an unsuccessful (also called reject) call response.
RequestContext: Evidence about a failed HTTP exchange, not permission to retry it.
Snapshot: Snapshot.
StartServerParams
SubnetBlockmakers
SubnetMetrics: A list of subnet metrics.
TickConfigs
Time: Representation of system time as duration since UNIX epoch with cross-platform nanosecond precision.

CanisterInstallMode: Canister Install Mode
ClientError: Failures from the maintained client. Sources are preserved without string matching.
CreateCanisterPlacement: Specifies where to place a newly created canister.
ErrorCode: User-facing error codes.
IngressStatusResult: This enum describes the result of retrieving ingress status. The IngressStatusResult::Forbidden variant is produced if an optional caller is provided and a corresponding read state request for the status of the same update call signed by that specified caller was rejected because the update call was submitted by a different caller.
RejectCode: User-facing reject codes.
TryFromError: Error type for TryFrom<u64>.

LATEST_SERVER_VERSION: Public to facilitate downloading the PocketIC server.

call_candid: Call a canister candid method, anonymous. PocketIC executes update calls synchronously, so there is no need to poll for the result.
call_candid_as: Call a canister candid method, authenticated. The sender can be impersonated (i.e., the signature is not verified). PocketIC executes update calls synchronously, so there is no need to poll for the result.
copy_dir
get_default_effective_canister_id: Retrieves a default effective canister id for canister creation on a PocketIC instance characterized by:
query_candid: Call a canister candid query method, anonymous.
query_candid_as: Call a canister candid query method, authenticated. The sender can be impersonated (i.e., the signature is not verified).
start_server: Attempt to start a new PocketIC server.
update_candid: Call a canister candid update method, anonymous.
update_candid_as: Call a canister candid update method, authenticated. The sender can be impersonated (i.e., the signature is not verified).
with_candid: A helper function that we use to implement both call_candid and query_candid.