Enum CanisterHttpReplication 

pub enum CanisterHttpReplication {
    FullyReplicated,
    NonReplicated,
    Flexible {
        total_requests: u32,
        min_responses: u32,
        max_responses: u32,
    },
}

How a canister HTTP outcall is replicated across the nodes of its subnet.

Variants

FullyReplicated

Every node of the subnet performs the outcall and a response is delivered once n - f of them agree on it. Too many differing responses make the outcall fail with a “no consensus could be reached” rejection instead. Mock such an outcall with PocketIc::mock_canister_http_response, whose additional_responses are what lets a test produce either outcome.

NonReplicated

One node of the subnet performs the outcall (is_replicated = false) and its response is the one delivered. PocketIC does not report which node was picked, so mock such an outcall with PocketIc::mock_canister_http_response like a fully replicated one: give it a single response, which every node then reports, and it is delivered no matter which node was picked. Differing additional_responses would instead make the delivered response unpredictable.

Flexible

A committee of total_requests nodes performs the outcall and between min_responses and max_responses of their (potentially differing) responses are delivered to the calling canister. Mock such an outcall with PocketIc::mock_flexible_canister_http_response.

Fields

total_requests: u32

The number of nodes performing the outcall.

min_responses: u32

The number of responses required to deliver a result.

max_responses: u32

The largest number of responses that may be delivered.

Trait Implementations

impl Clone for CanisterHttpReplication

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 CanisterHttpReplication

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CanisterHttpReplication

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for CanisterHttpReplication

impl Hash for CanisterHttpReplication

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 JsonSchema for CanisterHttpReplication

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Ord for CanisterHttpReplication

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 CanisterHttpReplication

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for CanisterHttpReplication

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 CanisterHttpReplication

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 CanisterHttpReplication