Module pic 

PocketIC host-test harness extensions.

Import the client and DTOs directly from ic_platform::pocket_ic. This module owns Testkit’s extension traits and policy types.

Construct and own ic_platform::pocket_ic::PocketIc instances normally, then import individual extension traits or prelude for installation, diagnostics and snapshots. Import the call functions, startup configuration and polling helpers explicitly. Native simulator operations remain upstream inherent methods.

PocketIcManagedServer can explicitly own one exact caller-selected server child for a serial suite. No type serializes independent instances or downloads a server implicitly. On Unix, server_assets owns explicit authenticated provisioning and admission; the published ic-testkit-server setup / check commands delegate to that implementation.

Modules

prelude

All PocketIC extension traits, and no data types.

server_assets

Explicit, release-bound PocketIC assets for Rust fixtures and the CLI.

Structs

BaselinePoolOutcome

One successful acquisition’s slot, timings and preparation disposition.

BaselinePoolTimings

Timings for one baseline-pool acquisition.

CachedPocketIcBaseline

One owned PocketIC instance/server record with snapshots and caller metadata.

CachedPocketIcBaselinePool

Caller-owned runtime-capacity pool of independently restorable PocketIC baselines.

CachedPocketIcBaselinePoolGuard

Exclusive lease of one validated pooled PocketIC baseline.

CanisterDiagnosticLogRecord

One canister-log record retained as bounded lossy UTF-8 text.

CanisterDiagnosticLogs

Successfully fetched canister logs after bounded text conversion.

CanisterDiagnosticsBatchEntry

One ordered labeled entry in a collect-all diagnostics batch.

CanisterDiagnosticsBatchReport

Ordered entries from a sequential collect-all diagnostics batch.

CanisterDiagnosticsReport

Independent status and log outcomes for one diagnostic collection.

CanisterDiagnosticsRequest

Exact controller-aware inputs for one best-effort diagnostic collection.

CanisterLogRenderLimits

Explicit bounds applied when canister logs are converted to diagnostic text.

CanisterSnapshotTarget

One canister and exact management-call sender used for snapshot capture.

ControllerSnapshots

Deterministically ordered snapshots retaining each successful capture sender.

InstallSpec

Inputs and diagnostic context for one generic canister installation.

LabeledCanisterDiagnosticsRequest

One caller-labeled exact diagnostic request in a collect-all batch.

PocketIcInstance

An upstream instance together with the server owned by its construction.

PocketIcManagedServer

Caller-owned PocketIC server process with bounded startup and output capture.

PocketIcManagedServerOutput

Bounded lossy UTF-8 output captured from a managed PocketIC server.

PocketIcOperationError

Captured PocketIC operation failure, retaining transport classification.

PocketIcStartupError

Original startup failure, bounded server output and typed cleanup failures.

ResetPolicies

Fixed non-snapshot reset policies, supplied independently by a recipe and its reset.

ResetReceipt

Typed reset guarantees actually achieved by one preparation pass.

ResetRequirements

Typed reset guarantees required by one fixture recipe.

RetryPolicy

Retry limits and simulated cooldown for install-code operations.

SnapshotCleanupFailure

Failure to remove a snapshot while rolling back a partial capture.

StandaloneCanisterFixture

One caller-built PocketIC instance/server owner and one installed canister.

StandaloneCanisterInstallError

Failed standalone install retaining the caller-created instance and optional server.

StandaloneCanisterRecipe

Snapshot-only recipe for one caller-built, installed canister.

Enums

BaselinePoolContractError

Contract failure while verifying recipe reset evidence.

BaselinePoolDisposition

Whether a baseline-pool lease was built, restored, or rebuilt.

BaselinePoolError

Failure to acquire a validated baseline-pool lease.

BaselinePoolPreparationError

One failed recipe or contract stage while preparing a baseline slot.

BaselinePreparationStage

Recipe stage associated with a structured preparation failure.

CanisterInstallError

Failed creation, funding, or installation with its original operation error.

ControllerSnapshotError

Structured controller-snapshot failure.

ExtraCanisterPolicy

Extra-canister handling required or achieved by one reset.

FailureDisposition

Recipe decision for a failed restored-slot preparation stage.

PocketIcCallFailure

A rejected management call or a captured PocketIC operation panic.

PocketIcStartupConfig

Explicit bounded source and policy for one PocketIC startup.

PocketIcStartupFailure

Original failure, independent of output capture and cleanup outcomes.

PreparedBaseline

Whether validation is observing a newly built or restored baseline.

RebuildReason

Why an invalid or failed slot was reconstructed.

ResetDomainKind

Reset domain whose handling is declared by a pooled baseline recipe.

SnapshotRestoreFunding

Caller-selected cycle funding applied immediately before snapshot restore.

StateResetPolicy

Generic handling for reset domains without a more specific policy.

TickUntilError

A caller-owned readiness check failed or exhausted its simulated round budget.

TimeResetPolicy

PocketIC time handling required or achieved by one reset.

Constants

DEFAULT_CANISTER_LOG_BYTE_LIMIT

Default maximum aggregate raw canister-log bytes retained in diagnostics.

DEFAULT_CANISTER_LOG_RECORD_LIMIT

Default maximum number of canister-log records retained in diagnostics.

POCKET_IC_SERVER_VERSION

The server selected by this Testkit release’s explicit provisioning CLI.

Traits

CanisterInstallExt

Generic canister installation and structured install-code retry policy.

PocketIcBaselineRecipe

Caller-owned build, preflight and non-snapshot reset policy for one pooled baseline.

PocketIcDiagnosticsExt

Reusable structured PocketIC failure diagnostics.

PocketIcSnapshotExt

Exact-sender capture and restore of related canister snapshots.

Functions

advance_and_tick

Advance simulated time once, then deliver exactly the caller-selected ticks.

is_dead_pocket_ic_transport_error

Recognize PocketIC transport failures in typed causes and request-error text.

pocket_ic_server_requirement

Human-readable stable server range accepted by supports_pocket_ic_server. Provisioning’s exact reviewed artifact version is selected independently.

supports_pocket_ic_server

Whether a successful server version probe satisfies Testkit’s protocol policy.

tick_until

Check a caller-owned predicate, advancing simulated time and ticking while pending.

try_pocket_ic_call

Execute one synchronous PocketIC call, retaining rejection or transport failure.

try_pocket_ic_operation

Execute one synchronous PocketIC operation, returning recognized transport panics.