Struct CanisterRole 

pub struct CanisterRole(pub Cow<'static, str>);

CanisterRole

A human-readable identifier for a canister role/type (e.g., “root”, “example”).

Stored as Cow<'static, str> so known constants can be zero‑copy while dynamic values allocate only when needed.

Tuple Fields

0: Cow<'static, str>

Implementations

impl CanisterRole

pub const ROOT: Self

pub const fn new(s: &'static str) -> Self

pub const fn owned(s: String) -> Self

pub fn as_str(&self) -> &str

pub fn is_root(&self) -> bool

Returns true if this type represents the built-in ROOT canister.

pub fn into_string(self) -> String

Convert into an owned string (avoids an extra allocation for owned variants).

Trait Implementations

impl AsRef<str> for CanisterRole

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<str> for CanisterRole

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl CandidType for CanisterRole

fn _ty() -> Type

fn id() -> TypeId

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

where __S: Serializer,

fn ty() -> Type

impl Clone for CanisterRole

fn clone(&self) -> CanisterRole

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CanisterRole

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CanisterRole

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CanisterRole

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

Formats the value using the given formatter.

impl From<&String> for CanisterRole

fn from(s: &String) -> Self

Converts to this type from the input type.

impl From<&'static str> for CanisterRole

fn from(s: &'static str) -> Self

Converts to this type from the input type.

impl From<CanisterRole> for String

fn from(ct: CanisterRole) -> Self

Converts to this type from the input type.

impl From<String> for CanisterRole

fn from(s: String) -> Self

Converts to this type from the input type.

impl FromStr for CanisterRole

type Err = String

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for CanisterRole

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 CanisterRole

fn cmp(&self, other: &CanisterRole) -> 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.

impl PartialEq for CanisterRole

fn eq(&self, other: &CanisterRole) -> 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 PartialOrd for CanisterRole

fn partial_cmp(&self, other: &CanisterRole) -> 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 CanisterRole

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Storable for CanisterRole

const BOUND: Bound

The size bounds of the type.

fn to_bytes(&self) -> Cow<'_, [u8]>

Converts the element into a possibly borrowed byte slice.

fn into_bytes(self) -> Vec<u8>

Converts the element into an owned byte vector.

fn from_bytes(bytes: Cow<'_, [u8]>) -> Self

Converts bytes into an element.

fn to_bytes_checked(&self) -> Cow<'_, [u8]>

Like to_bytes, but checks that bytes conform to declared bounds.

fn into_bytes_checked(self) -> Vec<u8>

where Self: Sized,

Like into_bytes, but checks that bytes conform to declared bounds.

fn check_bounds(bytes: &[u8])

Validates that a byte slice fits within this type’s declared bounds.

impl Eq for CanisterRole

impl StructuralPartialEq for CanisterRole