Struct Identifier

pub struct Identifier<A>(/* private fields */)
where
    A: Aleo;

An identifier is an immutable UTF-8 string, represented as a constant field element in the circuit.

Requirements

The identifier must not be an empty string. The identifier must not start with a number. The identifier must be alphanumeric, and may include underscores. The identifier must not consist solely of underscores. The identifier must fit within the data capacity of a base field element.

Implementations

impl<A> Identifier<A>

where A: Aleo,

pub fn size_in_bits(&self) -> Integer<A, u8>

Returns the number of bits of this identifier.

Trait Implementations

impl<A> Clone for Identifier<A>

where A: Clone + Aleo,

fn clone(&self) -> Identifier<A>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A> Debug for Identifier<A>

where A: Aleo,

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

Formats the value using the given formatter.

impl<A> Display for Identifier<A>

where A: Aleo,

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

Prints the identifier as a string.

impl<A> Eject for Identifier<A>

where A: Aleo,

fn eject_mode(&self) -> Mode

Ejects the mode of the identifier.

fn eject_value(&self) -> <Identifier<A> as Eject>::Primitive

Ejects the identifier as a string.

type Primitive = Identifier<<A 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<A> Equal for Identifier<A>

where A: Aleo,

fn is_equal(&self, other: &Identifier<A>) -> <Identifier<A> as Equal>::Output

Returns true if self and other are equal.

fn is_not_equal( &self, other: &Identifier<A>, ) -> <Identifier<A> as Equal>::Output

Returns true if self and other are not equal.

type Output = Boolean<A>

impl<A> From<&Identifier<A>> for LinearCombination<<A as Environment>::BaseField>

where A: Aleo,

fn from( identifier: &Identifier<A>, ) -> LinearCombination<<A as Environment>::BaseField>

Note: Identifier is always Mode::Constant.

impl<A> From<Identifier<A>> for LinearCombination<<A as Environment>::BaseField>

where A: Aleo,

fn from( identifier: Identifier<A>, ) -> LinearCombination<<A as Environment>::BaseField>

Note: Identifier is always Mode::Constant.

impl<A> FromBits for Identifier<A>

where A: Aleo,

fn from_bits_le( bits_le: &[<Identifier<A> as FromBits>::Boolean], ) -> Identifier<A>

Initializes a new identifier from a list of little-endian bits.

fn from_bits_be( bits_be: &[<Identifier<A> as FromBits>::Boolean], ) -> Identifier<A>

Initializes a new identifier from a list of big-endian bits.

type Boolean = Boolean<A>

impl<A> FromField for Identifier<A>

where A: Aleo,

fn from_field(field: <Identifier<A> as FromField>::Field) -> Identifier<A>

Initializes a new identifier from a field element.

type Field = Field<A>

impl<A> FromStr for Identifier<A>

where A: Aleo,

fn from_str(string: &str) -> Result<Identifier<A>, Error>

Parses a UTF-8 string into an identifier.

type Err = Error

The associated error which can be returned from parsing.

impl<A> Hash for Identifier<A>

where A: Aleo,

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

where H: Hasher,

Implements the Hash trait for the identifier.

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<A> Inject for Identifier<A>

where A: Aleo,

fn new( _: Mode, identifier: <Identifier<A> as Inject>::Primitive, ) -> Identifier<A>

Initializes a new identifier from a string. Note: Identifiers are always Mode::Constant.

type Primitive = Identifier<<A as Environment>::Network>

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

where Self: Sized,

Initializes a constant of the given primitive value.

impl<A> Parser for Identifier<A>

where A: Aleo,

fn parse(string: &str) -> Result<(&str, Identifier<A>), Err<VerboseError<&str>>>

Parses a UTF-8 string into an identifier.

impl<A> PartialEq for Identifier<A>

where A: Aleo,

fn eq(&self, other: &Identifier<A>) -> bool

Implements the Eq trait for the identifier.

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> ToBits for &Identifier<A>

where A: Aleo,

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

Returns the little-endian bits of the identifier.

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

Returns the big-endian bits of the identifier.

type Boolean = Boolean<A>

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<A> ToBits for Identifier<A>

where A: Aleo,

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

Returns the little-endian bits of the identifier.

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

Returns the big-endian bits of the identifier.

type Boolean = Boolean<A>

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<A> ToField for Identifier<A>

where A: Aleo,

fn to_field(&self) -> <Identifier<A> as ToField>::Field

Returns the identifier as a base field element.

type Field = Field<A>

impl<A> Eq for Identifier<A>

where A: Aleo,