Enum snarkvm_console_program::Literal

source · [−]

pub enum Literal<N: Network> {
Show 16 variants
    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>),
}

Expand description

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

source

impl<N: Network> Literal<N>

source

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.

source

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.

source

impl<N: Network> Literal<N>

source

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

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

source

impl<N: Network> Literal<N>

source

pub fn size_in_bits(&self) -> u16

Returns the number of bits of this literal.

source

impl<N: Network> Literal<N>

source

pub fn to_type(&self) -> LiteralType

Returns the type name of the literal.

source

impl<N: Network> Literal<N>

source

pub fn variant(&self) -> u8

Returns the variant of the literal.

Trait Implementations

source

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

source

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

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

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

source

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

Formats the value using the given formatter. Read more

source

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

source

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

Deserializes the literal from a string or bytes.

source

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

source

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

Formats the value using the given formatter. Read more

source

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

source

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

Returns true if self and other are equal.

source

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

Returns true if self and other are not equal.

type Output = Boolean<N>

source

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

source

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

Returns a new Plaintext from a Literal.

source

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

source

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

Returns a new Plaintext from a Literal.

source

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

source

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

Reads the literal from a buffer.

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

Returns Self from a byte array in little-endian order.

source

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

source

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.

source

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

source

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

Feeds a slice of this type into the given Hasher. Read more

source

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

source

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

Parses a string into a literal.

source

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

source

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

Returns true if self and other are equal.

1.0.0 · source

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. Read more

source

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

source

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

Serializes the literal into a string or as bytes.

source

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

source

fn to_bits_le(&self) -> Vec<bool>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Returns the little-endian bits of the literal.

source

fn to_bits_be(&self) -> Vec<bool>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Returns the big-endian bits of the literal.

source

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

source

fn to_bits_le(&self) -> Vec<bool>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Returns the little-endian bits of the literal.

source

fn to_bits_be(&self) -> Vec<bool>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Returns the big-endian bits of the literal.

source

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

source

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>

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

source

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

Auto Trait Implementations

impl<N> RefUnwindSafe for Literal<N> where
 N: RefUnwindSafe,
 <N as Environment>::Field: RefUnwindSafe,
 <N as Environment>::Projective: RefUnwindSafe,
 <N as Environment>::Scalar: RefUnwindSafe,

impl<N> Send for Literal<N>

impl<N> Sync for Literal<N>

impl<N> Unpin for Literal<N> where
 N: Unpin,
 <N as Environment>::Field: Unpin,
 <N as Environment>::Projective: Unpin,
 <N as Environment>::Scalar: Unpin,

impl<N> UnwindSafe for Literal<N> where
 N: UnwindSafe,
 <N as Environment>::Field: UnwindSafe,
 <N as Environment>::Projective: UnwindSafe,
 <N as Environment>::Scalar: UnwindSafe,

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CallHasher for T where
T: Hash + ?Sized,

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where
H: Hash + ?Sized,
B: BuildHasher,

source

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

source

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T> ToString for T where
T: Display + ?Sized,

source

default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

source

Enum snarkvm_console_program::Literal

Variants

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

Implementations

impl<N: Network> Literal<N>

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

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

impl<N: Network> Literal<N>

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

impl<N: Network> Literal<N>

pub fn size_in_bits(&self) -> u16

impl<N: Network> Literal<N>

pub fn to_type(&self) -> LiteralType

impl<N: Network> Literal<N>

pub fn variant(&self) -> u8

Trait Implementations

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

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

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

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

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

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

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

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

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

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

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

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

type Output = Boolean<N>

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

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

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

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

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

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

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

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

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

type Err = Error

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

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

fn hash_slice<H>(data: &[Self], state: &mut H) where H: Hasher,

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

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

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

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

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

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

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

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

fn to_bits_le(&self) -> Vec<bool>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

fn to_bits_be(&self) -> Vec<bool>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

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

fn to_bits_le(&self) -> Vec<bool>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

fn to_bits_be(&self) -> Vec<bool>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

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

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

fn to_bytes_le(&self) -> Result<Vec<u8, Global>, Error>

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

Auto Trait Implementations

impl<N> RefUnwindSafe for Literal<N> where N: RefUnwindSafe, <N as Environment>::Field: RefUnwindSafe, <N as Environment>::Projective: RefUnwindSafe, <N as Environment>::Scalar: RefUnwindSafe,

impl<N> Send for Literal<N>

impl<N> Sync for Literal<N>

impl<N> Unpin for Literal<N> where N: Unpin, <N as Environment>::Field: Unpin, <N as Environment>::Projective: Unpin, <N as Environment>::Scalar: Unpin,

impl<N> UnwindSafe for Literal<N> where N: UnwindSafe, <N as Environment>::Field: UnwindSafe, <N as Environment>::Projective: UnwindSafe, <N as Environment>::Scalar: UnwindSafe,

`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>)`

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

fn to_bits_le(&self) -> Vec<bool>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

fn to_bits_be(&self) -> Vec<bool>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

fn to_bits_le(&self) -> Vec<bool>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

fn to_bits_be(&self) -> Vec<bool>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

impl<N> RefUnwindSafe for Literal<N> where
N: RefUnwindSafe,
<N as Environment>::Field: RefUnwindSafe,
<N as Environment>::Projective: RefUnwindSafe,
<N as Environment>::Scalar: RefUnwindSafe,

impl<N> Unpin for Literal<N> where
N: Unpin,
<N as Environment>::Field: Unpin,
<N as Environment>::Projective: Unpin,
<N as Environment>::Scalar: Unpin,

impl<N> UnwindSafe for Literal<N> where
N: UnwindSafe,
<N as Environment>::Field: UnwindSafe,
<N as Environment>::Projective: UnwindSafe,
<N as Environment>::Scalar: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T> CallHasher for T where
T: Hash + ?Sized,

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where
H: Hash + ?Sized,
B: BuildHasher,

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T> ToString for T where
T: Display + ?Sized,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,