Enum EffectiveId 

pub enum EffectiveId {
    Canister(Principal),
    Subnet(Principal),
}

The effective ID that routes a request to a particular endpoint shape.

Most calls target a canister and are routed via an effective canister id. A small set of management-canister calls (currently create_canister, provisional_create_canister_with_cycles, and list_canisters) are instead routed via an effective subnet id, targeting the subnet-scoped HTTP endpoints (/api/v4/subnet/<id>/call, /api/v3/subnet/<id>/read_state, /api/v3/subnet/<id>/query).

Principal converts into EffectiveId::Canister(_), so passing a bare Principal to APIs that accept impl Into<EffectiveId> preserves the canister-scoped behavior of earlier ic-agent releases.

Variants

Canister(Principal)

An effective canister id. The request is routed to the canister-scoped HTTP endpoints.

Subnet(Principal)

An effective subnet id. The request is routed to the subnet-scoped HTTP endpoints.

Implementations

impl EffectiveId

pub fn as_principal(&self) -> Principal

Returns the underlying principal regardless of variant.

Trait Implementations

impl Clone for EffectiveId

fn clone(&self) -> EffectiveId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EffectiveId

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

Formats the value using the given formatter.

impl From<Principal> for EffectiveId

fn from(p: Principal) -> Self

Converts to this type from the input type.

impl Hash for EffectiveId

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 PartialEq for EffectiveId

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for EffectiveId

impl Eq for EffectiveId

impl StructuralPartialEq for EffectiveId