Struct IdentifierLiteral 

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

An identifier literal is an ASCII string (up to SIZE_IN_BYTES bytes) stored as a byte array.

The string content is stored as null-padded bytes in little-endian order.

Syntax: 'hello_world' (single-quoted, no type suffix). The allowed characters are: [a-zA-Z][a-zA-Z0-9_]*.

Implementations

impl<E> IdentifierLiteral<E>

where E: Environment,

pub fn new(string: &str) -> Result<IdentifierLiteral<E>, Error>

Creates a new identifier literal from a string. Allowed characters: [a-zA-Z][a-zA-Z0-9_]*.

pub fn from_bytes_array(bytes: [u8; 31]) -> Result<IdentifierLiteral<E>, Error>

Creates an identifier literal from a byte array, validating the contents.

pub fn bytes(&self) -> &[u8; 31]

Returns the bytes of the identifier literal.

pub fn length(&self) -> u8

Returns the length of the identifier (number of non-null bytes).

Trait Implementations

impl<N: Network> Cast<Address<N>> for IdentifierLiteral<N>

fn cast(&self) -> Result<Address<N>>

Casts an IdentifierLiteral to an Address.

impl<N: Network> Cast<Boolean<N>> for IdentifierLiteral<N>

fn cast(&self) -> Result<Boolean<N>>

Casts an IdentifierLiteral to a Boolean.

Note: This cast always fails because valid identifier literals start with a letter (first byte >= 0x41), which cannot represent a boolean field value (0 or 1). This implementation exists for uniformity with the impl_cast_body! macro used by all literal types.

impl<N: Network> Cast<Field<N>> for IdentifierLiteral<N>

fn cast(&self) -> Result<Field<N>>

Casts an IdentifierLiteral to a Field.

impl<N: Network> Cast<Group<N>> for IdentifierLiteral<N>

fn cast(&self) -> Result<Group<N>>

Casts an IdentifierLiteral to a Group.

impl<E: Environment> Cast<IdentifierLiteral<E>> for Boolean<E>

fn cast(&self) -> Result<IdentifierLiteral<E>>

Casts a Boolean to an IdentifierLiteral.

Note: This cast always fails because valid identifier literals cannot map to boolean values (0x00 or 0x01). The byte 0x00 is null and 0x01 (SOH) is not a valid identifier character. This implementation exists for uniformity with the impl_cast_body! macro used by all literal types.

impl<E: Environment> Cast<IdentifierLiteral<E>> for Field<E>

fn cast(&self) -> Result<IdentifierLiteral<E>>

Casts a Field to an IdentifierLiteral.

impl<E: Environment, I: IntegerType> Cast<IdentifierLiteral<E>> for Integer<E, I>

fn cast(&self) -> Result<IdentifierLiteral<E>>

Casts an Integer to an IdentifierLiteral.

impl<E: Environment> Cast<IdentifierLiteral<E>> for Scalar<E>

fn cast(&self) -> Result<IdentifierLiteral<E>>

Casts a Scalar to an IdentifierLiteral.

impl<N: Network, I: IntegerType> Cast<Integer<N, I>> for IdentifierLiteral<N>

fn cast(&self) -> Result<Integer<N, I>>

Casts an IdentifierLiteral to an Integer.

impl<N: Network> Cast<Scalar<N>> for IdentifierLiteral<N>

fn cast(&self) -> Result<Scalar<N>>

Casts an IdentifierLiteral to a Scalar.

impl<N: Network> Cast for IdentifierLiteral<N>

fn cast(&self) -> Result<IdentifierLiteral<N>>

Casts an IdentifierLiteral to itself.

impl<E> Clone for IdentifierLiteral<E>

where E: Clone + Environment,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E> Debug for IdentifierLiteral<E>

where E: Environment,

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

Formats the value using the given formatter.

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

where E: Environment,

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

where D: Deserializer<'de>,

Deserializes the identifier literal from a string or bytes.

impl<E> Display for IdentifierLiteral<E>

where E: Environment,

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

Formats the value using the given formatter.

impl<E> Distribution<IdentifierLiteral<E>> for Standard

where E: Environment,

fn sample<R>(&self, rng: &mut R) -> IdentifierLiteral<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 IdentifierLiteral<E>

where E: Environment,

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

Returns true if self and other are equal.

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

Returns true if self and other are not equal.

type Output = Boolean<E>

impl<E> FromBits for IdentifierLiteral<E>

where E: Environment,

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

Initializes an identifier literal from a list of little-endian bits.

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

Initializes an identifier literal from a list of big-endian bits.

impl<E> FromBytes for IdentifierLiteral<E>

where E: Environment,

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

where R: Read,

Reads the identifier literal 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.

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

where Self: Sized,

Same behavior as Self::from_bytes_le but avoids costly checks. This shall only be called when deserializing from a trusted source, such as local storage.

fn read_le_unchecked<R>(reader: R) -> Result<Self, Error>

where R: Read, Self: Sized,

Same behavior as Self::read_le but avoids costly checks. This shall only be called when deserializing from a trusted source, such as local storage.

fn read_le_with_unchecked<R>(reader: R, unchecked: bool) -> Result<Self, Error>

where R: Read, Self: Sized,

Helper function that deserializes either unchecked or checked based on the given boolean flag.

impl<E> FromField for IdentifierLiteral<E>

where E: Environment,

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

Creates an identifier literal from a field element.

type Field = Field<E>

impl<E> FromStr for IdentifierLiteral<E>

where E: Environment,

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

Parses a string into an identifier literal.

type Err = Error

The associated error which can be returned from parsing.

impl<E> Hash for IdentifierLiteral<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 IdentifierLiteral<E>

where E: Environment,

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

Parses a string into an identifier literal. Syntax: '<identifier>' where identifier matches [a-zA-Z][a-zA-Z0-9_]*.

impl<E> PartialEq for IdentifierLiteral<E>

where E: PartialEq + Environment,

fn eq(&self, other: &IdentifierLiteral<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 IdentifierLiteral<E>

where E: Environment,

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

where S: Serializer,

Serializes the identifier literal into a string or bytes.

impl<E> SizeInBits for IdentifierLiteral<E>

where E: Environment,

fn size_in_bits() -> usize

Returns the size in bits of the identifier literal.

impl<E> SizeInBytes for IdentifierLiteral<E>

where E: Environment,

fn size_in_bytes() -> usize

Returns the size in bytes of the identifier literal.

impl<E> ToBits for IdentifierLiteral<E>

where E: Environment,

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

Returns the little-endian bits of the identifier literal.

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

Returns the big-endian bits of the identifier literal.

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 IdentifierLiteral<E>

where E: Environment,

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

where W: Write,

Writes the identifier literal 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 IdentifierLiteral<E>

where E: Environment,

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

Returns the identifier literal as a field element.

type Field = Field<E>

impl<E> ToFields for IdentifierLiteral<E>

where E: Environment,

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

Converts the identifier literal to a list of field elements.

type Field = Field<E>

impl<E> TypeName for IdentifierLiteral<E>

where E: Environment,

fn type_name() -> &'static str

Returns the type name as a string.

impl<E> Copy for IdentifierLiteral<E>

where E: Copy + Environment,

impl<E> Eq for IdentifierLiteral<E>

where E: Eq + Environment,

impl<E> StructuralPartialEq for IdentifierLiteral<E>

where E: Environment,