Enum snarkvm_console_program::Literal

pub enum Literal<N: Network> {
    Address(Address<N>),
    Boolean(Boolean<N>),
    Field(Field<N>),
    Group(Group<N>),
    I8(I8<N>),
    I16(I16<N>),
    I32(I32<N>),
    I64(I64<N>),
    I128(I128<N>),
    U8(U8<N>),
    U16(U16<N>),
    U32(U32<N>),
    U64(U64<N>),
    U128(U128<N>),
    Scalar(Scalar<N>),
    String(StringType<N>),
}

The literal enum represents all supported types in snarkVM.

Variants

Address(Address<N>)

The Aleo address type.

Boolean(Boolean<N>)

The boolean type.

Field(Field<N>)

The field type.

Group(Group<N>)

The group type.

I8(I8<N>)

The 8-bit signed integer type.

I16(I16<N>)

The 16-bit signed integer type.

I32(I32<N>)

The 32-bit signed integer type.

I64(I64<N>)

The 64-bit signed integer type.

I128(I128<N>)

The 128-bit signed integer type.

U8(U8<N>)

The 8-bit unsigned integer type.

U16(U16<N>)

The 16-bit unsigned integer type.

U32(U32<N>)

The 32-bit unsigned integer type.

U64(U64<N>)

The 64-bit unsigned integer type.

U128(U128<N>)

The 128-bit unsigned integer type.

Scalar(Scalar<N>)

The scalar type.

String(StringType<N>)

The string type.

Implementations

impl<N: Network> Literal<N>

pub fn from_bits_le(variant: u8, bits_le: &[bool]) -> Result<Self>

Initializes a new literal from a list of little-endian bits without trailing zeros.

pub fn from_bits_be(variant: u8, bits_be: &[bool]) -> Result<Self>

Initializes a new literal from a list of big-endian bits without leading zeros.

impl<N: Network> Literal<N>

pub fn sample<R: Rng + CryptoRng>(literal_type: LiteralType, rng: &mut R) -> Self

Returns a randomly-sampled literal of the given literal type.

impl<N: Network> Literal<N>

pub fn size_in_bits(&self) -> u16

Returns the number of bits of this literal.

impl<N: Network> Literal<N>

pub fn to_type(&self) -> LiteralType

Returns the type name of the literal.

impl<N: Network> Literal<N>

pub fn variant(&self) -> u8

Returns the variant of the literal.

Trait Implementations

impl<N: Clone + Network> Clone for Literal<N>

fn clone(&self) -> Literal<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: Network> Debug for Literal<N>

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

Formats the value using the given formatter.

impl<'de, N: Network> Deserialize<'de> for Literal<N>

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

Deserializes the literal from a string or bytes.

impl<N: Network> Display for Literal<N>

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

Formats the value using the given formatter.

impl<N: Network> Equal<Literal<N>> for Literal<N>

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<N>

impl<N: Network> From<&Literal<N>> for Plaintext<N>

fn from(literal: &Literal<N>) -> Self

Returns a new Plaintext from a Literal.

impl<N: Network> From<Literal<N>> for Plaintext<N>

fn from(literal: Literal<N>) -> Self

Returns a new Plaintext from a Literal.

impl<N: Network> FromBytes for Literal<N>

fn read_le<R: Read>(reader: R) -> IoResult<Self>

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

impl<N: Network> FromStr for Literal<N>

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

Parses a string into a literal.

type Err = Error

The associated error which can be returned from parsing.

impl<N: Network> Hash for Literal<N>

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

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<N: Network> Parser for Literal<N>

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

Parses a string into a literal.

impl<N: Network> PartialEq<Literal<N>> for Literal<N>

fn eq(&self, other: &Self) -> bool

Returns true if self and other are equal.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<N: Network> Serialize for Literal<N>

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

Serializes the literal into a string or as bytes.

impl<N: Network> ToBits for &Literal<N>

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

Returns the little-endian bits of the literal.

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

Returns the big-endian bits of the literal.

impl<N: Network> ToBits for Literal<N>

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

Returns the little-endian bits of the literal.

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

Returns the big-endian bits of the literal.

impl<N: Network> ToBytes for Literal<N>

fn write_le<W: Write>(&self, writer: W) -> IoResult<()>

Writes the literal to a buffer.

fn to_bytes_le(&self) -> Result<Vec<u8, Global>, Error>where
    Self: Sized,

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

impl<N: Network> Eq for Literal<N>