Struct Address

pub struct Address<const NBYTES: usize> {
    pub(super) inner: [u8; NBYTES],
    pub(super) length: usize,
}

Fields

inner: [u8; NBYTES]

length: usize

Implementations

impl<const NBYTES: usize> Address<NBYTES>

pub fn to_linear_index(&self) -> u64

pub fn iter(&self) -> AddressIterator<NBYTES>

pub fn length(&self) -> usize

pub fn root() -> Self

pub const fn first(length: usize) -> Self

pub fn last(length: usize) -> Self

pub fn child_left(&self) -> Self

pub fn child_right(&self) -> Self

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

pub fn is_root(&self) -> bool

pub fn get(&self, index: usize) -> Direction

fn set(&mut self, index: usize)

fn unset(&mut self, index: usize)

pub fn nused_bytes(&self) -> usize

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

pub(super) fn clear_after(&mut self, index: usize)

fn set_after(&mut self, index: usize)

pub fn next(&self) -> Option<Self>

pub fn prev(&self) -> Option<Self>

pub fn next_depth(&self) -> Self

Returns first address in the next depth.

pub fn next_or_next_depth(&self) -> Self

Returns next address on the same depth or the first address in the next depth.

pub fn to_index(&self) -> AccountIndex

pub fn from_index(index: AccountIndex, length: usize) -> Self

pub fn iter_children(&self, length: usize) -> AddressChildrenIterator<NBYTES>

pub fn is_before(&self, other: &Self) -> bool

pub fn is_parent_of(&self, other: &Self) -> bool

pub fn to_string(&self) -> String

pub fn to_bits(&self) -> [bool; 35]

Trait Implementations

impl<F: FieldWitness, const N: usize> Check<F> for Address<N>

fn check(&self, _w: &mut Witness<F>)

impl<const NBYTES: usize> Clone for Address<NBYTES>

fn clone(&self) -> Address<NBYTES>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const NBYTES: usize> Debug for Address<NBYTES>

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

Formats the value using the given formatter.

impl<'de, const NBYTES: usize> Deserialize<'de> for Address<NBYTES>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const NBYTES: usize> From<&MerkleAddressBinableArgStableV1> for Address<NBYTES>

fn from( MerkleAddressBinableArgStableV1: &MerkleAddressBinableArgStableV1, ) -> Self

Converts to this type from the input type.

impl<const NBYTES: usize> From<Address<NBYTES>> for MerkleAddressBinableArgStableV1

fn from(value: Address<NBYTES>) -> Self

Converts to this type from the input type.

impl<const NBYTES: usize> From<MerkleAddressBinableArgStableV1> for Address<NBYTES>

fn from(value: MerkleAddressBinableArgStableV1) -> Self

Converts to this type from the input type.

impl<const NBYTES: usize> IntoIterator for Address<NBYTES>

type Item = Direction

The type of the elements being iterated over.

type IntoIter = AddressIterator<NBYTES>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<const NBYTES: usize> Ord for Address<NBYTES>

fn cmp(&self, other: &Address<NBYTES>) -> 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<const NBYTES: usize> PartialEq for Address<NBYTES>

fn eq(&self, other: &Self) -> 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<const NBYTES: usize> PartialOrd for Address<NBYTES>

fn partial_cmp(&self, other: &Address<NBYTES>) -> 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<const NBYTES: usize> Serialize for Address<NBYTES>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<F: FieldWitness, const N: usize> ToFieldElements<F> for Address<N>

fn to_field_elements(&self, fields: &mut Vec<F>)

fn to_field_elements_owned(&self) -> Vec<F>

impl<'a, const NBYTES: usize> TryFrom<&'a str> for Address<NBYTES>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(s: &'a str) -> Result<Self, Self::Error>

Performs the conversion.

impl<const NBYTES: usize> Eq for Address<NBYTES>