Struct Address

pub struct Address<E>
where
    E: Environment,
{ /* private fields */ }

Implementations

impl<E> Address<E>

where E: Environment,

pub const fn to_group(&self) -> &Group<E>

Returns the address as a group element.

impl<E> Address<E>

where E: Environment,

pub const fn new(group: Group<E>) -> Address<E>

Initializes an address from a group element.

pub fn zero() -> Address<E>

Initializes a zero address.

Methods from Deref<Target = Group<E>>

pub fn to_x_coordinate(&self) -> Field<E>

Returns the x-coordinate in the affine coordinates of the group.

pub fn to_xy_coordinates(&self) -> (Field<E>, Field<E>)

Returns the x-coordinate and y-coordinate in the affine coordinates of the group.

pub fn to_y_coordinate(&self) -> Field<E>

Returns the y-coordinate in the affine coordinates of the group.

pub const EDWARDS_A: Field<E> = _

pub const EDWARDS_D: Field<E> = _

pub const MONTGOMERY_A: Field<E> = _

pub const MONTGOMERY_B: Field<E> = _

pub fn mul_by_cofactor(&self) -> Group<E>

Returns self * COFACTOR.

pub fn div_by_cofactor(&self) -> Group<E>

Returns self / COFACTOR.

Trait Implementations

impl<E> Clone for Address<E>

where E: Clone + Environment,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E> Compare for Address<E>

where E: Environment,

fn is_less_than(&self, other: &Address<E>) -> <Address<E> as Compare>::Output

Returns true if self is less than other.

fn is_greater_than(&self, other: &Address<E>) -> <Address<E> as Compare>::Output

Returns true if self is greater than other.

fn is_less_than_or_equal( &self, other: &Address<E>, ) -> <Address<E> as Compare>::Output

Returns true if self is less than or equal to other.

fn is_greater_than_or_equal( &self, other: &Address<E>, ) -> <Address<E> as Compare>::Output

Returns true if self is greater than or equal to other.

type Output = Boolean<E>

impl<E> Debug for Address<E>

where E: Environment,

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

Formats the value using the given formatter.

impl<E> Deref for Address<E>

where E: Environment,

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

Returns the address as a group element.

type Target = Group<E>

The resulting type after dereferencing.

impl<'de, E> Deserialize<'de> for Address<E>

where E: Environment,

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

where D: Deserializer<'de>,

Deserializes an account address from a string or bytes.

impl<E> Display for Address<E>

where E: Environment,

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

Writes an account address as a bech32m string.

impl<E> Distribution<Address<E>> for Standard

where E: Environment,

fn sample<R>(&self, rng: &mut R) -> Address<E>

where R: Rng + ?Sized,

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>

where R: Rng, Self: Sized,

Create an iterator that generates random values of T, using rng as the source of randomness.

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S>

where F: Fn(T) -> S, Self: Sized,

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F

impl<E> Equal for Address<E>

where E: Environment,

fn is_equal(&self, other: &Address<E>) -> <Address<E> as Equal>::Output

Returns true if self and other are equal.

fn is_not_equal(&self, other: &Address<E>) -> <Address<E> as Equal>::Output

Returns true if self and other are not equal.

type Output = Boolean<E>

impl<E> FromBits for Address<E>

where E: Environment,

fn from_bits_le(bits_le: &[bool]) -> Result<Address<E>, Error>

Initializes a new address by recovering the x-coordinate of an affine group from a list of little-endian bits.

fn from_bits_be(bits_be: &[bool]) -> Result<Address<E>, Error>

Initializes a new address by recovering the x-coordinate of an affine group from a list of big-endian bits.

impl<E> FromBytes for Address<E>

where E: Environment,

fn read_le<R>(reader: R) -> Result<Address<E>, Error>

where R: Read,

Reads in an account address from a buffer.

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

where Self: Sized,

Returns Self from a byte array in little-endian order.

impl<E> FromField for Address<E>

where E: Environment,

fn from_field( field: &<Address<E> as FromField>::Field, ) -> Result<Address<E>, Error>

Initializes a new address by recovering the x-coordinate of an affine group from a field element.

type Field = Field<E>

impl<E> FromFields for Address<E>

where E: Environment,

fn from_fields( fields: &[<Address<E> as FromFields>::Field], ) -> Result<Address<E>, Error>

Initializes a new address by recovering the x-coordinate of an affine group from a field element.

type Field = Field<E>

impl<E> FromStr for Address<E>

where E: Environment,

fn from_str(address: &str) -> Result<Address<E>, <Address<E> as FromStr>::Err>

Reads in an account address string.

type Err = Error

The associated error which can be returned from parsing.

impl<E> Hash for Address<E>

where E: Hash + Environment,

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<E> Parser for Address<E>

where E: Environment,

fn parse(string: &str) -> Result<(&str, Address<E>), Err<VerboseError<&str>>>

Parses a string into an address.

impl<E> PartialEq for Address<E>

where E: PartialEq + Environment,

fn eq(&self, other: &Address<E>) -> 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<E> Serialize for Address<E>

where E: Environment,

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

where S: Serializer,

Serializes an account address into a string or as bytes.

impl<E> SizeInBits for Address<E>

where E: Environment,

fn size_in_bits() -> usize

Returns the address size in bits.

impl<E> SizeInBytes for Address<E>

where E: Environment,

fn size_in_bytes() -> usize

Returns the address size in bytes.

impl<E> Ternary for Address<E>

where E: Environment,

fn ternary( condition: &<Address<E> as Ternary>::Boolean, first: &Address<E>, second: &Address<E>, ) -> <Address<E> as Ternary>::Output

Returns first if condition is true, otherwise returns second.

type Boolean = Boolean<E>

type Output = Address<E>

impl<E> ToBits for Address<E>

where E: Environment,

fn write_bits_le(&self, vec: &mut Vec<bool>)

Outputs the little-endian bit representation of self.to_x_coordinate() without trailing zeros.

fn write_bits_be(&self, vec: &mut Vec<bool>)

Outputs the big-endian bit representation of self.to_x_coordinate() without leading zeros.

fn to_bits_le(&self) -> Vec<bool>

Returns self as a boolean array in little-endian order.

fn to_bits_be(&self) -> Vec<bool>

Returns self as a boolean array in big-endian order.

fn num_bits() -> Option<usize>

An optional indication of how many bits an object can be represented with.

impl<E> ToBytes for Address<E>

where E: Environment,

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

where W: Write,

Writes an account address to a buffer.

fn to_bytes_le(&self) -> Result<Vec<u8>, Error>

where Self: Sized,

Returns self as a byte array in little-endian order.

impl<E> ToField for Address<E>

where E: Environment,

fn to_field(&self) -> Result<<Address<E> as ToField>::Field, Error>

Returns the address as a field element.

type Field = Field<E>

impl<E> ToFields for Address<E>

where E: Environment,

fn to_fields(&self) -> Result<Vec<<Address<E> as ToFields>::Field>, Error>

Returns the address as field elements.

type Field = Field<E>

impl<N: Network> TryFrom<&ComputeKey<N>> for Address<N>

fn try_from(compute_key: &ComputeKey<N>) -> Result<Self, Self::Error>

Derives the account address from an account compute key.

type Error = Error

The type returned in the event of a conversion error.

impl<N: Network> TryFrom<&PrivateKey<N>> for Address<N>

fn try_from(private_key: &PrivateKey<N>) -> Result<Self, Self::Error>

Derives the account address from an account private key.

type Error = Error

The type returned in the event of a conversion error.

impl<N: Network> TryFrom<&ViewKey<N>> for Address<N>

fn try_from(view_key: &ViewKey<N>) -> Result<Self, Self::Error>

Derives the account address from an account view key.

type Error = Error

The type returned in the event of a conversion error.

impl<N: Network> TryFrom<ComputeKey<N>> for Address<N>

fn try_from(compute_key: ComputeKey<N>) -> Result<Self, Self::Error>

Derives the account address from an account compute key.

type Error = Error

The type returned in the event of a conversion error.

impl<N: Network> TryFrom<PrivateKey<N>> for Address<N>

fn try_from(private_key: PrivateKey<N>) -> Result<Self, Self::Error>

Derives the account address from an account private key.

type Error = Error

The type returned in the event of a conversion error.

impl<N: Network> TryFrom<ViewKey<N>> for Address<N>

fn try_from(view_key: ViewKey<N>) -> Result<Self, Self::Error>

Derives the account address from an account view key.

type Error = Error

The type returned in the event of a conversion error.

impl<E> TypeName for Address<E>

where E: Environment,

fn type_name() -> &'static str

Returns the type name as a string.

impl<E> Visibility for Address<E>

where E: Environment,

fn size_in_fields(&self) -> Result<u16, Error>

Returns the number of field elements to encode self.

type Boolean = Boolean<E>

impl<E> AddressTrait for Address<E>

where E: Environment,

impl<E> Copy for Address<E>

where E: Copy + Environment,

impl<E> Eq for Address<E>

where E: Eq + Environment,

impl<E> StructuralPartialEq for Address<E>

where E: Environment,