Struct MockCanisterHttpResponse 

pub struct MockCanisterHttpResponse {
    pub subnet_id: Principal,
    pub request_id: u64,
    pub response: CanisterHttpResponse,
    pub additional_responses: Vec<CanisterHttpResponse>,
}

Mocked responses to a pending canister HTTP outcall made through the http_request management canister endpoint — whether fully replicated or non-replicated (see CanisterHttpReplication). A flexible outcall is answered with MockFlexibleCanisterHttpResponse instead.

This answers for every node of the subnet, which is what an http_request outcall needs: a fully replicated one is performed by all of them, and a non-replicated one by a single node that is not exposed. It is therefore also the only shape that can make the nodes of a fully replicated outcall disagree (see additional_responses).

An http_request outcall answered this way reports one of:

• the mocked response — as a reply, or as a rejection of the calling canister’s call carrying the mocked code and message;
• SysTransient and “No consensus could be reached” if its nodes disagree (see additional_responses; a non-replicated outcall has no such outcome, it just delivers its designated node’s response);
• SysTransient and “Out of cycles” if what the nodes left unspent of their per-replica cycles allowances no longer covers putting a response into a block;
• SysTransient and “Canister http request timed out” once the outcall is older than its 60 second timeout.

Fields

subnet_id: Principal

request_id: u64

response: CanisterHttpResponse

The response every node of the subnet reports, unless additional_responses is non-empty — in which case this is the response of one node and additional_responses holds the rest.

With this response alone, all nodes agree, so a fully replicated outcall delivers it (see CanisterHttpReplication::FullyReplicated).

additional_responses: Vec<CanisterHttpResponse>

The responses of the remaining nodes of the subnet. Either empty — then response is used for every node — or exactly one short of the subnet size, so that together with response there is one response per node.

This is how a test makes the nodes of a fully replicated outcall disagree: unless n - f of the n responses are equal, it fails with a “no consensus could be reached” rejection.

A non-replicated outcall has nothing to disagree about — only its designated node’s response is delivered, and PocketIC does not report which node that is — so differing responses merely make the delivered one unpredictable. Leave this empty unless the disagreement is what is under test.

Trait Implementations

impl Clone for MockCanisterHttpResponse

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MockCanisterHttpResponse

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MockCanisterHttpResponse

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for MockCanisterHttpResponse

impl From<MockCanisterHttpResponse> for RawMockCanisterHttpResponse

fn from(mock_canister_http_response: MockCanisterHttpResponse) -> Self

Converts to this type from the input type.

impl From<RawMockCanisterHttpResponse> for MockCanisterHttpResponse

fn from(raw_mock_canister_http_response: RawMockCanisterHttpResponse) -> Self

Converts to this type from the input type.

impl Hash for MockCanisterHttpResponse

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for MockCanisterHttpResponse

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for MockCanisterHttpResponse

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for MockCanisterHttpResponse

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for MockCanisterHttpResponse

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MockCanisterHttpResponse