Struct Address 

pub struct Address<E>(/* private fields */)
where
    E: Environment;

Implementations

impl<E> Address<E>

where E: Environment,

pub fn zero() -> Address<E>

Initializes the zero address.

Trait Implementations

impl<E> Cast<Address<E>> for Boolean<E>

where E: Environment,

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

Casts a Boolean to an Address.

impl<E> Cast<Address<E>> for Field<E>

where E: Environment,

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

Casts a Field to an Address.

This operation attempts to recover the group element from the field element, and then constructs an address from the group element.

To cast arbitrary field elements to addresses, use Field::cast_lossy.

impl<E, I> Cast<Address<E>> for Integer<E, I>

where E: Environment, I: IntegerType,

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

Casts an Integer to an Address.

This operation converts the integer to a field element, and then attempts to recover the group element by treating the field element as an x-coordinate. The group element is then converted to an address.

To cast arbitrary integers to addresses, use Integer::cast_lossy.

impl<E> Cast<Address<E>> for Scalar<E>

where E: Environment,

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

Casts a Scalar to an Address.

This operation converts the scalar to a field element, and then attempts to recover the group element by treating the field element as an x-coordinate. The group element is then converted to an address.

To cast arbitrary scalars to addresses, use Scalar::cast_lossy.

impl<E> CastLossy<Address<E>> for Boolean<E>

where E: Environment,

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

Casts a Boolean to an Address. This is safe because casting from a boolean to any other type is always lossless.

If the boolean is true, the address is the generator of the prime-order subgroup. If the boolean is false, the address is the zero group element.

impl<E> CastLossy<Address<E>> for Field<E>

where E: Environment,

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

Casts a Field to an Address.

This operation attempts to recover the group element from the given field, which is then used to construct the address. See the documentation of Field::cast_lossy on the Group type for more details.

impl<E, I> CastLossy<Address<E>> for Integer<E, I>

where E: Environment, I: IntegerType,

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

Casts an Integer to an Address.

This operation converts the integer into a field element, and then attempts to recover the group element to construct the address. See the documentation of Field::cast_lossy on the Group type for more details.

impl<E> CastLossy<Address<E>> for Scalar<E>

where E: Environment,

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

Casts a Scalar to an Address.

This operation converts the scalar into a field element, and then attempts to recover the group element to construct the address. See the documentation of Field::cast_lossy on the Group type for more details.

impl<E> Clone for Address<E>

where E: Clone + Environment,

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

Returns a duplicate 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> Display for Address<E>

where E: Environment,

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

Formats the value using the given formatter.

impl<E> Eject for Address<E>

where E: Environment,

fn eject_mode(&self) -> Mode

Ejects the mode of the address.

fn eject_value(&self) -> <Address<E> as Eject>::Primitive

Ejects the address.

type Primitive = Address<<E as Environment>::Network>

fn eject(&self) -> (Mode, Self::Primitive)

Ejects the mode and primitive value of the circuit type.

fn is_constant(&self) -> bool

Returns true if the circuit is a constant.

fn is_public(&self) -> bool

Returns true if the circuit is a public.

fn is_private(&self) -> bool

Returns true if the circuit is a private.

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> From<&Address<E>> for Field<E>

where E: Environment,

fn from(value: &Address<E>) -> Field<E>

Returns the x-coordinate of the affine group element in the address.

impl<E> From<&Address<E>> for Group<E>

where E: Environment,

fn from(value: &Address<E>) -> Group<E>

Returns the affine group element in the address.

impl<E> From<&Address<E>> for LinearCombination<<E as Environment>::BaseField>

where E: Environment,

fn from( address: &Address<E>, ) -> LinearCombination<<E as Environment>::BaseField>

Converts to this type from the input type.

impl<E> From<&Field<E>> for Address<E>

where E: Environment,

fn from(value: &Field<E>) -> Address<E>

Initializes an address from the x-coordinate of an affine group element.

impl<E> From<&Group<E>> for Address<E>

where E: Environment,

fn from(value: &Group<E>) -> Address<E>

Initializes an address from an affine group element.

impl<A> From<Address<A>> for Literal<A>

where A: Aleo,

fn from(value: Address<A>) -> Literal<A>

Converts to this type from the input type.

impl<E> From<Address<E>> for Field<E>

where E: Environment,

fn from(value: Address<E>) -> Field<E>

Returns the x-coordinate of the affine group element in the address.

impl<E> From<Address<E>> for Group<E>

where E: Environment,

fn from(value: Address<E>) -> Group<E>

Returns the affine group element in the address.

impl<E> From<Address<E>> for LinearCombination<<E as Environment>::BaseField>

where E: Environment,

fn from(address: Address<E>) -> LinearCombination<<E as Environment>::BaseField>

Converts to this type from the input type.

impl<E> From<Field<E>> for Address<E>

where E: Environment,

fn from(value: Field<E>) -> Address<E>

Initializes an address from the x-coordinate of an affine group element.

impl<E> From<Group<E>> for Address<E>

where E: Environment,

fn from(value: Group<E>) -> Address<E>

Initializes an address from an affine group element.

impl<E> FromBits for Address<E>

where E: Environment,

fn from_bits_le(bits_le: &[<Address<E> as FromBits>::Boolean]) -> Address<E>

Initializes an address from a list of little-endian bits without trailing zeros.

fn from_bits_be(bits_be: &[<Address<E> as FromBits>::Boolean]) -> Address<E>

Initializes an address from a list of big-endian bits without leading zeros.

type Boolean = Boolean<E>

impl<E> FromField for Address<E>

where E: Environment,

fn from_field(x_coordinate: Field<E>) -> Address<E>

Initializes an address from the x-coordinate of an affine group element.

type Field = Field<E>

impl<E> FromGroup for Address<E>

where E: Environment,

fn from_group(group: <Address<E> as FromGroup>::Group) -> Address<E>

Initializes an address from an affine group element.

type Group = Group<E>

type Scalar = Scalar<E>

impl<E> FromStr for Address<E>

where E: Environment,

fn from_str(string: &str) -> Result<Address<E>, Error>

Parses a string into a address.

type Err = Error

The associated error which can be returned from parsing.

impl<E> Inject for Address<E>

where E: Environment,

fn new(mode: Mode, address: <Address<E> as Inject>::Primitive) -> Address<E>

Initializes a new instance of an address.

type Primitive = Address<<E as Environment>::Network>

fn constant(value: Self::Primitive) -> Self

where Self: Sized,

Initializes a constant of the given primitive value.

impl<E> Metrics<dyn Ternary<Output = Address<E>, Boolean = Boolean<E>>> for Address<E>

where E: Environment,

type Case = (Mode, Mode, Mode)

fn count( case: &<Address<E> as Metrics<dyn Ternary<Output = Address<E>, Boolean = Boolean<E>>>>::Case, ) -> Count

Returns the number of constants, public inputs, private inputs, and constraints.

impl<E> OutputMode<dyn Ternary<Output = Address<E>, Boolean = Boolean<E>>> for Address<E>

where E: Environment,

type Case = (CircuitType<Boolean<E>>, Mode, Mode)

fn output_mode( parameter: &<Address<E> as OutputMode<dyn Ternary<Output = Address<E>, Boolean = Boolean<E>>>>::Case, ) -> Mode

Returns the mode of the output.

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 circuit.

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<<&Address<E> as ToBits>::Boolean>)

Outputs the little-endian bit representation of self.x without trailing zeros.

fn write_bits_be(&self, vec: &mut Vec<<&Address<E> as ToBits>::Boolean>)

Outputs the big-endian bit representation of self.x without leading zeros.

type Boolean = Boolean<E>

fn to_bits_le(&self) -> Vec<Self::Boolean>

Returns the little-endian bits of the circuit.

fn to_bits_be(&self) -> Vec<Self::Boolean>

Returns the big-endian bits of the circuit.

impl<E> ToBits for Address<E>

where E: Environment,

fn write_bits_le(&self, vec: &mut Vec<<Address<E> as ToBits>::Boolean>)

Outputs the little-endian bit representation of self.x without trailing zeros.

fn write_bits_be(&self, vec: &mut Vec<<Address<E> as ToBits>::Boolean>)

Outputs the big-endian bit representation of self.x without leading zeros.

type Boolean = Boolean<E>

fn to_bits_le(&self) -> Vec<Self::Boolean>

Returns the little-endian bits of the circuit.

fn to_bits_be(&self) -> Vec<Self::Boolean>

Returns the big-endian bits of the circuit.

impl<E> ToField for Address<E>

where E: Environment,

fn to_field(&self) -> Field<E>

Returns the x-coordinate of the affine group element in the address.

type Field = Field<E>

impl<E> ToGroup for Address<E>

where E: Environment,

fn to_group(&self) -> <Address<E> as ToGroup>::Group

Returns the affine group element in the address.

type Group = Group<E>

type Scalar = Scalar<E>

impl<E> TypeName for Address<E>

where E: Environment,

fn type_name() -> &'static str

Returns the type name of the circuit as a string.

impl<E> AddressTrait for Address<E>

where E: Environment,