Expand description
The PocketIC server and the PocketIc library interface with HTTP/JSON. The types in this module are used to serialize and deserialize data from and to JSON, and are used by both crates.
Modules§
Structs§
- ApiError
- Auto
Progress Config - Binary
Blob - BlobId
- Canister
Http Header - Canister
Http Reject - Canister
Http Reply - Canister
Http Request - Canister
IdRange - Extended
Subnet Config Set - Http
Gateway Config - Http
Gateway Details - Http
Gateway Info - Https
Config - IcpConfig
- Specifies ICP config of this instance.
- IcpFeatures
- Specifies ICP features enabled by deploying their corresponding system canisters
when creating a PocketIC instance and keeping them up to date
during the PocketIC instance lifetime.
The subnets to which the corresponding system canisters are deployed must be empty,
i.e., their corresponding field in
ExtendedSubnetConfigSetmust beNoneorSome(config)withconfig.state_config = SubnetStateConfig::New. An ICP feature is enabled if itsIcpFeaturesConfigis provided, i.e., if the corresponding field is notNone. - Instance
Config - Instance
Http Gateway Config - Mock
Canister Http Response - Mocked responses to a pending canister HTTP outcall made through the
http_requestmanagement canister endpoint — whether fully replicated or non-replicated (seeCanisterHttpReplication). A flexible outcall is answered withMockFlexibleCanisterHttpResponseinstead. - Mock
Flexible Canister Http Response - Mocked responses to a pending flexible canister HTTP outcall, i.e. one made
through the
flexible_http_requestmanagement canister endpoint. - Named
Subnet Iter - An iterator over the variants of NamedSubnet
- RawAdd
Cycles - RawCanister
Call - RawCanister
Http Request - RawCanister
Id - RawCanister
Snapshot Download - RawCanister
Snapshot Id - RawCanister
Snapshot Upload - RawCycles
- RawIngress
Status Args - RawMessage
Id - RawMock
Canister Http Response - RawMock
Flexible Canister Http Response - RawNode
Id - RawPrincipal
Id - RawSender
Info - RawSet
Stable Memory - RawStable
Memory - RawSubnet
Blockmakers - RawSubnet
Id - RawTick
Configs - RawTime
- RawVerify
Canister SigArg - Started
OrBusy Response - Subnet
Config - Configuration details for a subnet, returned by PocketIc server
- Subnet
Config Set - This represents which named subnets the user wants to create, and how many of the general app/system subnets, which are indistinguishable.
- Subnet
Kind Iter - An iterator over the variants of SubnetKind
- Subnet
Spec - Specifies various configurations for a subnet.
- Topology
Enums§
- ApiResponse
- Blob
Compression - Canister
Cycles Cost Schedule - Specifies how to charge canisters for their use of computational resources (such as executing instructions, storing data, network, etc.).
- Canister
Http Method - Canister
Http Pricing Version - The pricing model applied to a canister HTTP outcall.
- Canister
Http Replication - How a canister HTTP outcall is replicated across the nodes of its subnet.
- Canister
Http Response - Create
Http Gateway Response - Create
Instance Response - Http
Gateway Backend - IcpConfig
Flag - IcpFeatures
Config - Incomplete
State Flag - Initial
Time - Named
Subnet - Named subnets have a fixed canister ID range on the IC mainnet and at most one instance per PocketIC instance.
- RawCanister
Result - RawEffective
Principal - Relevant for calls to the management canister. If a subnet ID is provided, the call will be sent to the management canister of that subnet. If a canister ID is provided, the call will be sent to the management canister of the subnet where the canister is on. If None, the call will be sent to any management canister.
- Subnet
Instruction Config - Specifies instruction limits for canister execution on this subnet.
- Subnet
Kind - Subnet
State Config - Specifies whether the subnet should be created from scratch or loaded from a path.