Skip to main content

Principal

Struct Principal 

Source
pub struct Principal { /* private fields */ }
Expand description

An opaque IC identity containing at most 29 significant bytes.

Ordering compares length first, then bytes. Binary Serde includes only the significant bytes; human-readable Serde uses canonical Principal text. Deserialization accepts string or byte callbacks, but not numeric sequences.

Implementations§

Source§

impl Principal

Source

pub const MAX_LENGTH_IN_BYTES: usize = 29

The maximum significant binary length.

Source

pub const MAX_LENGTH_IN_TEXT: usize = 63

The maximum admitted UTF-8 byte length of Principal text.

Source

pub const fn management_canister() -> Principal

Returns the zero-byte management canister identity.

Source

pub const fn anonymous() -> Principal

Returns the one-byte anonymous identity, whose byte is 4.

Source

pub const fn from_slice(slice: &[u8]) -> Principal

Copies significant bytes into a Principal.

§Panics

Panics if slice contains more than 29 bytes.

Source

pub const fn try_from_slice(slice: &[u8]) -> Result<Principal, PrincipalError>

Copies bytes, returning PrincipalError::BytesTooLong above 29 bytes.

Source

pub fn from_text<S>(text: S) -> Result<Principal, PrincipalError>
where S: AsRef<str>,

Parses bounded, checksummed Base32 text with canonical dash grouping.

ASCII case differences are accepted. Inputs longer than 63 bytes are refused before decoding. Whitespace and padding are not accepted.

Source

pub fn to_text(&self) -> String

Returns lowercase canonical text with a dash after every five digits.

Source

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

Borrows only the significant bytes.

Source

pub const fn len(&self) -> u8

Returns the significant byte length; zero identifies the management canister.

Source

pub const fn as_fixed_bytes(&self) -> &[u8; 29]

Borrows the fixed storage, whose tail after Self::len is zero.

Source

pub fn write_text<'a>(&self, output: &'a mut [u8; 63]) -> &'a str

Write canonical Principal text into caller-owned storage without allocation.

The returned string borrows the supplied buffer. No identity authority or normalization beyond canonical text formatting is implied.

§Panics

Panics if the Base32 supplier violates its ASCII output contract.

Trait Implementations§

Source§

impl AsRef<[u8]> for Principal

Source§

fn as_ref(&self) -> &[u8] ⓘ

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

impl Clone for Principal

Source§

fn clone(&self) -> Principal

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Principal

Source§

impl Debug for Principal

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn deserialize<D>( deserializer: D, ) -> Result<Principal, <D as Deserializer<'de>>::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for Principal

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Principal

Source§

impl From<Principal> for Account

Source§

fn from(owner: Principal) -> Account

Converts to this type from the input type.
Source§

impl From<Principal> for IndexValue<'_>

Source§

fn from(value: Principal) -> Self

Converts to this type from the input type.
Source§

impl FromStr for Principal

Source§

type Err = PrincipalError

The associated error which can be returned from parsing.
Source§

fn from_str(text: &str) -> Result<Principal, <Principal as FromStr>::Err>

Parses a string s to return a value of this type. Read more
Source§

impl Hash for Principal

Source§

fn hash<__H>(&self, state: &mut __H)
where __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for Principal

Source§

fn cmp(&self, other: &Principal) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

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. Read more
Source§

impl PartialEq for Principal

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialOrd for Principal

Source§

fn partial_cmp(&self, other: &Principal) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl PrimaryKey for Principal

Source§

impl Serialize for Principal

Source§

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. Read more
Source§

impl StructuralPartialEq for Principal

Source§

impl TryFrom<&Vec<u8>> for Principal

Source§

type Error = PrincipalError

The type returned in the event of a conversion error.
Source§

fn try_from( bytes: &Vec<u8>, ) -> Result<Principal, <Principal as TryFrom<&Vec<u8>>>::Error>

Performs the conversion.
Source§

impl TryFrom<&[u8]> for Principal

Source§

type Error = PrincipalError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl TryFrom<&str> for Principal

Source§

type Error = PrincipalError

The type returned in the event of a conversion error.
Source§

fn try_from( text: &str, ) -> Result<Principal, <Principal as TryFrom<&str>>::Error>

Performs the conversion.
Source§

impl TryFrom<Vec<u8>> for Principal

Source§

type Error = PrincipalError

The type returned in the event of a conversion error.
Source§

fn try_from( bytes: Vec<u8>, ) -> Result<Principal, <Principal as TryFrom<Vec<u8>>>::Error>

Performs the conversion.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.