Struct Identifier

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

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: Aleo> Identifier<A>

pub fn size_in_bits(&self) -> U8<A>

Returns the number of bits of this identifier.

Trait Implementations

impl<A: Clone + Aleo> Clone for Identifier<A>

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: Aleo> Debug for Identifier<A>

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

Formats the value using the given formatter.

impl<A: Aleo> Display for Identifier<A>

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

Prints the identifier as a string.

impl<A: Aleo> Eject for Identifier<A>

fn eject_mode(&self) -> Mode

Ejects the mode of the identifier.

fn eject_value(&self) -> Self::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: Aleo> Equal for Identifier<A>

fn is_equal(&self, other: &Self) -> Self::Output

Returns true if self and other are equal.

fn is_not_equal(&self, other: &Self) -> Self::Output

Returns true if self and other are not equal.

type Output = Boolean<A>

impl<A: Aleo> From<&Identifier<A>> for LinearCombination<A::BaseField>

fn from(identifier: &Identifier<A>) -> Self

Note: Identifier is always Mode::Constant.

impl<A: Aleo> From<Identifier<A>> for LinearCombination<A::BaseField>

fn from(identifier: Identifier<A>) -> Self

Note: Identifier is always Mode::Constant.

impl<A: Aleo> FromBits for Identifier<A>

fn from_bits_le(bits_le: &[Self::Boolean]) -> Self

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

fn from_bits_be(bits_be: &[Self::Boolean]) -> Self

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

type Boolean = Boolean<A>

impl<A: Aleo> FromField for Identifier<A>

fn from_field(field: Self::Field) -> Self

Initializes a new identifier from a field element.

type Field = Field<A>

impl<A: Aleo> FromStr for Identifier<A>

fn from_str(string: &str) -> Result<Self>

Parses a UTF-8 string into an identifier.

type Err = Error

The associated error which can be returned from parsing.

impl<A: Aleo> Hash for Identifier<A>

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

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

fn new(_: Mode, identifier: Self::Primitive) -> Self

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: Aleo> Parser for Identifier<A>

fn parse(string: &str) -> ParserResult<'_, Self>

Parses a UTF-8 string into an identifier.

impl<A: Aleo> PartialEq for Identifier<A>

fn eq(&self, other: &Self) -> 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: Aleo> ToBits for &Identifier<A>

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

Returns the little-endian bits of the identifier.

fn write_bits_be(&self, vec: &mut Vec<Self::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: Aleo> ToBits for Identifier<A>

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

Returns the little-endian bits of the identifier.

fn write_bits_be(&self, vec: &mut Vec<Self::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: Aleo> ToField for Identifier<A>

fn to_field(&self) -> Self::Field

Returns the identifier as a base field element.

type Field = Field<A>

impl<A: Aleo> Eq for Identifier<A>