Struct Principal 

pub struct Principal(/* private fields */);

Canonical principal atom.

Implementations

impl Principal

pub const MAX_LENGTH_IN_BYTES: u32 = 29

Maximum canonical principal byte length.

pub const MIN: Self

Minimum byte-ordered principal.

pub const MAX: Self

Maximum byte-ordered principal.

pub const fn anonymous() -> Self

Return the anonymous principal.

pub fn from_text(text: &str) -> Result<Self, PrincipalError>

Parse canonical textual principal form.

Errors

Returns PrincipalError::InvalidText for invalid text.

pub const fn from_slice(bytes: &[u8]) -> Self

Construct from canonical principal bytes.

Panics

Panics when bytes exceeds the canonical 29-byte principal limit. Use Principal::try_from_bytes for untrusted input.

pub const fn as_slice(&self) -> &[u8]

Borrow canonical principal bytes.

pub const fn stored_bytes(&self) -> Result<&[u8], PrincipalEncodeError>

Borrow bounded canonical bytes.

Errors

Returns a typed error if an upstream value violates the canonical principal length.

pub fn to_bytes(self) -> Result<Vec<u8>, PrincipalEncodeError>

Copy bounded canonical bytes.

Errors

Returns a typed error for an invalid upstream representation.

pub const fn try_from_bytes(bytes: &[u8]) -> Result<Self, PrincipalDecodeError>

Decode bounded canonical bytes.

Errors

Returns a typed error when bytes exceeds the principal bound.

Trait Implementations

impl CandidType for Principal

fn _ty() -> Type

fn _ty_doc() -> TypeDoc

fn id() -> TypeId

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

where __S: Serializer,

fn ty() -> Type

impl Clone for Principal

fn clone(&self) -> Principal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Principal

impl Debug for Principal

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Principal

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Principal

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

Formats the value using the given formatter.

impl Eq for Principal

impl From<Principal> for Account

fn from(owner: Principal) -> Self

Converts to this type from the input type.

impl From<Principal> for Principal

fn from(value: Principal) -> Self

Converts to this type from the input type.

impl From<Principal> for Principal

fn from(value: Principal) -> Self

Converts to this type from the input type.

impl From<Principal> for Subaccount

fn from(principal: Principal) -> Self

Converts to this type from the input type.

impl FromStr for Principal

type Err = PrincipalError

The associated error which can be returned from parsing.

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

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

impl Hash for Principal

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 Principal

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Principal

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

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 Principal

impl TryFrom<&[u8]> for Principal

type Error = PrincipalDecodeError

The type returned in the event of a conversion error.

fn try_from(bytes: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.