Struct AccountId 

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

NEAR Account Identifier.

This is a unique, syntactically valid, human-readable account identifier on the NEAR network.

See the crate-level docs for information about validation.

Also see Error kind precedence.

Examples

use near_account_id::AccountId;

let alice: AccountId = "alice.near".parse().unwrap();

assert!("ƒelicia.near".parse::<AccountId>().is_err()); // (ƒ is not f)

Implementations

impl AccountId

pub const MIN_LEN: usize = crate::validation::MIN_LEN

Shortest valid length for a NEAR Account ID.

pub const MAX_LEN: usize = crate::validation::MAX_LEN

Longest valid length for a NEAR Account ID.

pub fn validate(account_id: &str) -> Result<(), ParseAccountError>

Validates a string as a well-structured NEAR Account ID.

Checks Account ID validity without constructing an AccountId instance.

Examples

use near_account_id::{AccountId, ParseErrorKind};

assert!(AccountId::validate("alice.near").is_ok());

assert!(
  matches!(
    AccountId::validate("ƒelicia.near"), // fancy ƒ!
    Err(err) if err.kind() == &ParseErrorKind::InvalidChar
  )
);

Error kind precedence

If an Account ID has multiple format violations, the first one would be reported.

Examples

use near_account_id::{AccountId, ParseErrorKind};

assert!(
  matches!(
    AccountId::validate("A__ƒƒluent."),
    Err(err) if err.kind() == &ParseErrorKind::InvalidChar
  )
);

assert!(
  matches!(
    AccountId::validate("a__ƒƒluent."),
    Err(err) if err.kind() == &ParseErrorKind::RedundantSeparator
  )
);

assert!(
  matches!(
    AccountId::validate("aƒƒluent."),
    Err(err) if err.kind() == &ParseErrorKind::InvalidChar
  )
);

assert!(
  matches!(
    AccountId::validate("affluent."),
    Err(err) if err.kind() == &ParseErrorKind::RedundantSeparator
  )
);

Methods from Deref<Target = AccountIdRef>

pub const MIN_LEN: usize = crate::validation::MIN_LEN

pub const MAX_LEN: usize = crate::validation::MAX_LEN

pub fn as_bytes(&self) -> &[u8]

Returns a reference to the account ID bytes.

pub fn as_str(&self) -> &str

Returns a string slice of the entire Account ID.

Examples

use near_account_id::AccountIdRef;

let carol = AccountIdRef::new("carol.near").unwrap();
assert_eq!("carol.near", carol.as_str());

pub fn is_top_level(&self) -> bool

Returns true if the account ID is a top-level NEAR Account ID.

See Top-level Accounts.

Examples

use near_account_id::AccountIdRef;

let near_tla = AccountIdRef::new("near").unwrap();
assert!(near_tla.is_top_level());

// "alice.near" is a sub account of "near" account
let alice = AccountIdRef::new("alice.near").unwrap();
assert!(!alice.is_top_level());

pub fn sub_account( &self, name: impl AsRef<str>, ) -> Result<AccountId, ParseAccountError>

Returns sub account of current account: {name}.{parent}.

Returns Err if the resulting sub account is invalid (e.g. too long).

Examples

use near_account_id::AccountIdRef;

let parent = AccountIdRef::new("near").unwrap();
let child = parent.sub_account("alice").unwrap();

assert!(child.is_sub_account_of(parent));

pub fn parent(&self) -> Option<&AccountIdRef>

Returns parent account if current account is a subaccount.

Examples

use near_account_id::AccountIdRef;

let tla = AccountIdRef::new("near").unwrap();
assert_eq!(tla.parent(), None);

let child = AccountIdRef::new("alice.near").unwrap();
let parent = child.parent().unwrap();

assert_eq!(parent, "near");
assert!(child.is_sub_account_of(parent));

pub fn is_sub_account_of(&self, parent: impl AsRef<AccountIdRef>) -> bool

Returns true if the AccountId is a direct sub-account of the provided parent account.

See Subaccounts.

Examples

use near_account_id::AccountId;

let near_tla: AccountId = "near".parse().unwrap();
assert!(near_tla.is_top_level());

let alice: AccountId = "alice.near".parse().unwrap();
assert!(alice.is_sub_account_of(&near_tla));

let alice_app: AccountId = "app.alice.near".parse().unwrap();

// While app.alice.near is a sub account of alice.near,
// app.alice.near is not a sub account of near
assert!(alice_app.is_sub_account_of(&alice));
assert!(!alice_app.is_sub_account_of(&near_tla));

pub fn get_account_type(&self) -> AccountType

Returns AccountType::EthImplicitAccount if the AccountId is a 40 characters long hexadecimal prefixed with ‘0x’. Returns AccountType::NearImplicitAccount if the AccountId is a 64 characters long hexadecimal. Otherwise, returns AccountType::NamedAccount.

See Implicit-Accounts.

Examples

use near_account_id::{AccountId, AccountType};

let alice: AccountId = "alice.near".parse().unwrap();
assert!(alice.get_account_type() == AccountType::NamedAccount);

let eth_rando = "0xb794f5ea0ba39494ce839613fffba74279579268"
    .parse::<AccountId>()
    .unwrap();
assert!(eth_rando.get_account_type() == AccountType::EthImplicitAccount);

let near_rando = "98793cd91a3f870fb126f66285808c7e094afcfc4eda8a970f6648cdf0dbd6de"
    .parse::<AccountId>()
    .unwrap();
assert!(near_rando.get_account_type() == AccountType::NearImplicitAccount);

pub fn is_system(&self) -> bool

Returns true if this AccountId is the system account.

See System account.

Examples

use near_account_id::AccountId;

let alice: AccountId = "alice.near".parse().unwrap();
assert!(!alice.is_system());

let system: AccountId = "system".parse().unwrap();
assert!(system.is_system());

pub fn len(&self) -> usize

Returns the length of the underlying account id string.

pub fn get_parent_account_id(&self) -> Option<&AccountIdRef>

Returns parent’s account id reference

Examples

use near_account_id::AccountIdRef;

let alice: &AccountIdRef = AccountIdRef::new_or_panic("alice.near");
let parent: &AccountIdRef = alice.get_parent_account_id().unwrap();

assert!(alice.is_sub_account_of(parent));

let near: &AccountIdRef = AccountIdRef::new_or_panic("near");

assert!(near.get_parent_account_id().is_none());

let implicit: &AccountIdRef = AccountIdRef::new_or_panic("248e104d1d4764d713c4211c13808c8fc887869c580f4178e60538ac5c2a0b26");

assert!(implicit.get_parent_account_id().is_none());

Trait Implementations

impl AsRef<AccountIdRef> for AccountId

fn as_ref(&self) -> &AccountIdRef

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

impl AsRef<str> for AccountId

fn as_ref(&self) -> &str

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

impl Borrow<AccountIdRef> for AccountId

fn borrow(&self) -> &AccountIdRef

Immutably borrows from an owned value.

impl BorshDeserialize for AccountId

fn deserialize_reader<R>(rd: &mut R) -> Result<AccountId, Error>

where R: Read,

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl BorshSerialize for AccountId

fn serialize<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write,

impl Clone for AccountId

fn clone(&self) -> AccountId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AccountId

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

Formats the value using the given formatter.

impl Deref for AccountId

type Target = AccountIdRef

The resulting type after dereferencing.

fn deref(&self) -> &<AccountId as Deref>::Target

Dereferences the value.

impl<'de> Deserialize<'de> for AccountId

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for AccountId

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

Formats the value using the given formatter.

impl Eq for AccountId

impl<'a> From<&'a AccountIdRef> for AccountId

fn from(id: &'a AccountIdRef) -> AccountId

Converts to this type from the input type.

impl From<&AccountId> for AccountId

fn from(value: &AccountId) -> AccountId

Converts to this type from the input type.

impl From<AccountId> for String

fn from(account_id: AccountId) -> String

Converts to this type from the input type.

impl From<AccountId> for ContractState

fn from(value: AccountId) -> Self

Converts to this type from the input type.

impl<'a> From<Cow<'a, AccountIdRef>> for AccountId

fn from(value: Cow<'a, AccountIdRef>) -> AccountId

Converts to this type from the input type.

impl FromStr for AccountId

type Err = ParseAccountError

The associated error which can be returned from parsing.

fn from_str(account_id: &str) -> Result<AccountId, <AccountId as FromStr>::Err>

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

impl Hash for AccountId

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

where __H: Hasher,

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 AccountId

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

fn eq(&self, other: &AccountId) -> 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<'a> PartialEq<&'a AccountIdRef> for AccountId

fn eq(&self, other: &&'a AccountIdRef) -> 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<'a> PartialEq<&'a str> for AccountId

fn eq(&self, other: &&'a str) -> 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 PartialEq<AccountId> for AccountIdRef

fn eq(&self, other: &AccountId) -> 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<'a> PartialEq<AccountId> for &'a AccountIdRef

fn eq(&self, other: &AccountId) -> 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 PartialEq<AccountId> for String

fn eq(&self, other: &AccountId) -> 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 PartialEq<AccountId> for str

fn eq(&self, other: &AccountId) -> 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<'a> PartialEq<AccountId> for &'a str

fn eq(&self, other: &AccountId) -> 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 PartialEq<AccountIdRef> for AccountId

fn eq(&self, other: &AccountIdRef) -> 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 PartialEq<String> for AccountId

fn eq(&self, other: &String) -> 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 PartialEq<str> for AccountId

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

fn partial_cmp(&self, other: &AccountId) -> 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<'a> PartialOrd<&'a AccountIdRef> for AccountId

fn partial_cmp(&self, other: &&'a AccountIdRef) -> 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<'a> PartialOrd<&'a str> for AccountId

fn partial_cmp(&self, other: &&'a str) -> 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 PartialOrd<AccountId> for AccountIdRef

fn partial_cmp(&self, other: &AccountId) -> 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<'a> PartialOrd<AccountId> for &'a AccountIdRef

fn partial_cmp(&self, other: &AccountId) -> 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 PartialOrd<AccountId> for String

fn partial_cmp(&self, other: &AccountId) -> 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 PartialOrd<AccountId> for str

fn partial_cmp(&self, other: &AccountId) -> 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<'a> PartialOrd<AccountId> for &'a str

fn partial_cmp(&self, other: &AccountId) -> 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 PartialOrd<AccountIdRef> for AccountId

fn partial_cmp(&self, other: &AccountIdRef) -> 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 PartialOrd<String> for AccountId

fn partial_cmp(&self, other: &String) -> 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 PartialOrd<str> for AccountId

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

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.

impl StructuralPartialEq for AccountId

impl TryFrom<&str> for AccountId

type Error = ParseAccountError

The type returned in the event of a conversion error.

fn try_from( account_id: &str, ) -> Result<AccountId, <AccountId as TryFrom<&str>>::Error>

Performs the conversion.

impl TryFrom<Box<str>> for AccountId

type Error = ParseAccountError

The type returned in the event of a conversion error.

fn try_from( account_id: Box<str>, ) -> Result<AccountId, <AccountId as TryFrom<Box<str>>>::Error>

Performs the conversion.

impl TryFrom<String> for AccountId

type Error = ParseAccountError

The type returned in the event of a conversion error.

fn try_from( account_id: String, ) -> Result<AccountId, <AccountId as TryFrom<String>>::Error>

Performs the conversion.

impl TryIntoAccountId for AccountId

fn try_into_account_id(self) -> Result<AccountId, ParseAccountError>

Converts this type into an owned AccountId.

fn as_str(&self) -> &str

impl TryIntoAccountId for &AccountId

fn try_into_account_id(self) -> Result<AccountId, ParseAccountError>

Converts this type into an owned AccountId.

fn as_str(&self) -> &str