Enum AccountIdPrefix

pub enum AccountIdPrefix {
    V0(AccountIdPrefixV0),
}

The prefix of an AccountId, i.e. its first field element.

See the AccountId documentation for details.

The serialization formats of AccountIdPrefix and AccountId are compatible. In particular, a prefix can be deserialized from the serialized bytes of a full id.

Variants

V0(AccountIdPrefixV0)

Implementations

impl AccountIdPrefix

pub const SERIALIZED_SIZE: usize = 8usize

The serialized size of an AccountIdPrefix in bytes.

pub fn new_unchecked(prefix: Felt) -> Self

Constructs a new AccountIdPrefix from the given prefix without checking its validity.

Warning

Validity of the ID prefix must be ensured by the caller. An invalid ID may lead to panics.

Panics

Panics if the prefix does not contain a known account ID version.

If debug_assertions are enabled (e.g. in debug mode), this function panics if the given felt is invalid according to the constraints in the AccountId documentation.

pub fn new(prefix: Felt) -> Result<Self, AccountIdError>

Constructs a new AccountIdPrefix from the given prefix and checks its validity.

Errors

Returns an error if any of the ID constraints are not met. See the constraints documentation for details.

pub const fn as_felt(&self) -> Felt

Returns the Felt that represents this prefix.

pub const fn as_u64(&self) -> u64

Returns the prefix as a u64.

pub const fn account_type(&self) -> AccountType

Returns the type of this account ID.

pub fn is_faucet(&self) -> bool

Returns true if an account with this ID is a faucet (can issue assets).

pub fn is_regular_account(&self) -> bool

Returns true if an account with this ID is a regular account.

pub fn storage_mode(&self) -> AccountStorageMode

Returns the storage mode of this account ID.

pub fn is_onchain(&self) -> bool

Returns true if the full state of the account is on chain, i.e. if the modes are AccountStorageMode::Public or AccountStorageMode::Network, false otherwise.

pub fn is_public(&self) -> bool

Returns true if the storage mode is AccountStorageMode::Public, false otherwise.

pub fn is_network(&self) -> bool

Returns true if the storage mode is AccountStorageMode::Network, false otherwise.

pub fn is_private(&self) -> bool

Returns true if self is a private account, false otherwise.

pub fn version(&self) -> AccountIdVersion

Returns the version of this account ID.

pub fn to_hex(self) -> String

Returns the prefix as a big-endian, hex-encoded string.

Trait Implementations

impl Clone for AccountIdPrefix

fn clone(&self) -> AccountIdPrefix

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AccountIdPrefix

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

Formats the value using the given formatter.

impl Deserializable for AccountIdPrefix

fn read_from<R: ByteReader>( source: &mut R, ) -> Result<Self, DeserializationError>

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result.

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

impl Display for AccountIdPrefix

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

Formats the value using the given formatter.

impl From<AccountIdPrefix> for [u8; 8]

fn from(id: AccountIdPrefix) -> Self

Converts to this type from the input type.

impl From<AccountIdPrefix> for Felt

fn from(id: AccountIdPrefix) -> Self

Converts to this type from the input type.

impl From<AccountIdPrefix> for u64

fn from(id: AccountIdPrefix) -> Self

Converts to this type from the input type.

impl From<AccountIdPrefixV0> for AccountIdPrefix

fn from(id: AccountIdPrefixV0) -> Self

Converts to this type from the input type.

impl Ord for AccountIdPrefix

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

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

fn partial_cmp(&self, other: &Self) -> 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 Serializable for AccountIdPrefix

fn write_into<W: ByteWriter>(&self, target: &mut W)

Serializes self into bytes and writes these bytes into the target.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

fn to_bytes(&self) -> Vec<u8>

Serializes self into a vector of bytes.

impl TryFrom<[u8; 8]> for AccountIdPrefix

fn try_from(value: [u8; 8]) -> Result<Self, Self::Error>

Tries to convert a byte array in big-endian order to an AccountIdPrefix.

Errors

Returns an error if any of the ID constraints are not met. See the constraints documentation for details.

type Error = AccountIdError

The type returned in the event of a conversion error.

impl TryFrom<BaseElement> for AccountIdPrefix

fn try_from(element: Felt) -> Result<Self, Self::Error>

Returns an AccountIdPrefix instantiated with the provided field element.

Errors

Returns an error if any of the ID constraints are not met. See the constraints documentation for details.

type Error = AccountIdError

The type returned in the event of a conversion error.

impl TryFrom<u64> for AccountIdPrefix

fn try_from(value: u64) -> Result<Self, Self::Error>

Tries to convert a u64 into an AccountIdPrefix.

Errors

Returns an error if any of the ID constraints are not met. See the constraints documentation for details.

type Error = AccountIdError

The type returned in the event of a conversion error.

impl Copy for AccountIdPrefix

impl Eq for AccountIdPrefix

impl StructuralPartialEq for AccountIdPrefix