Enum EnvelopeContent

pub enum EnvelopeContent {
    Call {
        nonce: Option<Vec<u8>>,
        ingress_expiry: u64,
        sender: Principal,
        canister_id: Principal,
        method_name: String,
        arg: Vec<u8>,
    },
    ReadState {
        ingress_expiry: u64,
        sender: Principal,
        paths: Vec<Vec<Label<Vec<u8>>>>,
    },
    Query {
        ingress_expiry: u64,
        sender: Principal,
        canister_id: Principal,
        method_name: String,
        arg: Vec<u8>,
        nonce: Option<Vec<u8>>,
    },
}

The content of an IC ingress message, not including any signature information.

Variants

Call

A replicated call to a canister method, whether update or query.

Fields

nonce: Option<Vec<u8>>

A random series of bytes to uniquely identify this message.

ingress_expiry: u64

A nanosecond timestamp after which this request is no longer valid.

sender: Principal

The principal that is sending this request.

canister_id: Principal

The ID of the canister to be called.

method_name: String

The name of the canister method to be called.

arg: Vec<u8>

The argument to pass to the canister method.

ReadState

A request for information from the IC state tree.

Fields

ingress_expiry: u64

A nanosecond timestamp after which this request is no longer valid.

sender: Principal

The principal that is sending this request.

paths: Vec<Vec<Label<Vec<u8>>>>

A list of paths within the state tree to fetch.

Query

An unreplicated call to a canister query method.

Fields

ingress_expiry: u64

A nanosecond timestamp after which this request is no longer valid.

sender: Principal

The principal that is sending this request.

canister_id: Principal

The ID of the canister to be called.

method_name: String

The name of the canister method to be called.

arg: Vec<u8>

The argument to pass to the canister method.

nonce: Option<Vec<u8>>

A random series of bytes to uniquely identify this message.

Implementations

impl EnvelopeContent

pub fn ingress_expiry(&self) -> u64

Returns the ingress_expiry field common to all variants.

pub fn sender(&self) -> &Principal

Returns the sender field common to all variants.

pub fn to_request_id(&self) -> RequestId

Converts the envelope content to a request ID.

Equivalent to calling to_request_id, but infallible.

Trait Implementations

impl Clone for EnvelopeContent

fn clone(&self) -> EnvelopeContent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EnvelopeContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EnvelopeContent

fn deserialize<__D>( __deserializer: __D, ) -> Result<EnvelopeContent, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for EnvelopeContent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.