Struct snarkvm_wasm::traits::utilities::uint::UInt8

pub struct UInt8 {
    pub bits: Vec<Boolean, Global>,
    pub negated: bool,
    pub value: Option<u8>,
}

Fields

bits: Vec<Boolean, Global>

negated: bool

value: Option<u8>

Implementations

impl UInt8

pub fn constant_vec(values: &[u8]) -> Vec<UInt8, Global>

Construct a constant vector of UInt8 from a vector of u8

pub fn alloc_vec<F, CS, T>(
    cs: CS,
    values: &[T]
) -> Result<Vec<UInt8, Global>, SynthesisError> where
    CS: ConstraintSystem<F>,
    T: Into<Option<u8>> + Copy,
    F: Field, 

pub fn alloc_input_vec_le<F, CS>(
    cs: CS,
    values: &[u8]
) -> Result<Vec<UInt8, Global>, SynthesisError> where
    CS: ConstraintSystem<F>,
    F: PrimeField, 

Allocates a vector of u8’s by first converting (chunks of) them to F elements, (thus reducing the number of input allocations), and then converts this list of F gadgets back into bytes.

Trait Implementations

impl<F> Add<F, UInt8> for UInt8 where
    F: Field + PrimeField, 

type ErrorType = UnsignedIntegerError

pub fn add<CS>(
    &self,
    cs: CS,
    other: &UInt8
) -> Result<UInt8, <UInt8 as Add<F, UInt8>>::ErrorType> where
    CS: ConstraintSystem<F>, 

impl<F> AllocGadget<<UInt8 as Integer>::IntegerType, F> for UInt8 where
    F: Field, 

pub fn alloc<Fn, T, CS>(cs: CS, value_gen: Fn) -> Result<UInt8, SynthesisError> where
    Fn: FnOnce() -> Result<T, SynthesisError>,
    CS: ConstraintSystem<F>,
    T: Borrow<<UInt8 as Integer>::IntegerType>, 

pub fn alloc_input<Fn, T, CS>(
    cs: CS,
    value_gen: Fn
) -> Result<UInt8, SynthesisError> where
    Fn: FnOnce() -> Result<T, SynthesisError>,
    CS: ConstraintSystem<F>,
    T: Borrow<<UInt8 as Integer>::IntegerType>, 

fn alloc_constant<Fn, T, CS>(_cs: CS, _f: Fn) -> Result<Self, SynthesisError> where
    Fn: FnOnce() -> Result<T, SynthesisError>,
    CS: ConstraintSystem<F>,
    T: Borrow<V>, 

fn alloc_checked<Fn, T, CS>(cs: CS, f: Fn) -> Result<Self, SynthesisError> where
    Fn: FnOnce() -> Result<T, SynthesisError>,
    CS: ConstraintSystem<F>,
    T: Borrow<V>, 

fn alloc_input_checked<Fn, T, CS>(cs: CS, f: Fn) -> Result<Self, SynthesisError> where
    Fn: FnOnce() -> Result<T, SynthesisError>,
    CS: ConstraintSystem<F>,
    T: Borrow<V>, 

impl Clone for UInt8

pub fn clone(&self) -> UInt8

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F> ComparatorGadget<F> for UInt8 where
    F: Field + PrimeField, 

fn greater_than<CS>(
    &self,
    cs: CS,
    other: &Self
) -> Result<Boolean, SynthesisError> where
    CS: ConstraintSystem<F>, 

fn less_than_or_equal<CS>(
    &self,
    cs: CS,
    other: &Self
) -> Result<Boolean, SynthesisError> where
    CS: ConstraintSystem<F>, 

fn greater_than_or_equal<CS>(
    &self,
    cs: CS,
    other: &Self
) -> Result<Boolean, SynthesisError> where
    CS: ConstraintSystem<F>, 

impl<F> CondSelectGadget<F> for UInt8 where
    F: PrimeField, 

pub fn conditionally_select<CS>(
    cs: CS,
    cond: &Boolean,
    first: &UInt8,
    second: &UInt8
) -> Result<UInt8, SynthesisError> where
    CS: ConstraintSystem<F>, 

pub fn cost() -> usize

impl<F> ConditionalEqGadget<F> for UInt8 where
    F: Field, 

pub fn conditional_enforce_equal<CS>(
    &self,
    cs: CS,
    other: &UInt8,
    condition: &Boolean
) -> Result<(), SynthesisError> where
    CS: ConstraintSystem<F>, 

pub fn cost() -> usize

impl Debug for UInt8

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

Formats the value using the given formatter.

impl<F> Div<F, UInt8> for UInt8 where
    F: PrimeField, 

type ErrorType = UnsignedIntegerError

pub fn div<CS>(
    &self,
    cs: CS,
    other: &UInt8
) -> Result<UInt8, <UInt8 as Div<F, UInt8>>::ErrorType> where
    CS: ConstraintSystem<F>, 

impl<F> EqGadget<F> for UInt8 where
    F: Field, 

fn is_eq<CS>(&self, _cs: CS, _other: &Self) -> Result<Boolean, SynthesisError> where
    CS: ConstraintSystem<F>, 

Output a Boolean value representing whether self.value() == other.value().

fn enforce_equal<CS>(&self, cs: CS, other: &Self) -> Result<(), SynthesisError> where
    CS: ConstraintSystem<F>, 

fn cost() -> usize

impl<F> EvaluateEqGadget<F> for UInt8 where
    F: PrimeField, 

pub fn evaluate_equal<CS>(
    &self,
    cs: CS,
    other: &UInt8
) -> Result<Boolean, SynthesisError> where
    CS: ConstraintSystem<F>, 

impl<F> EvaluateLtGadget<F> for UInt8 where
    F: Field + PrimeField, 

pub fn less_than<CS>(
    &self,
    cs: CS,
    other: &UInt8
) -> Result<Boolean, SynthesisError> where
    CS: ConstraintSystem<F>, 

impl Integer for UInt8

type IntegerType = u8

pub const SIZE: usize

pub fn constant(value: u8) -> UInt8

pub fn one() -> UInt8

pub fn zero() -> UInt8

pub fn new(
    bits: Vec<Boolean, Global>,
    value: Option<<UInt8 as Integer>::IntegerType>
) -> UInt8

pub fn is_constant(&self) -> bool

Returns true if all bits in this Int are constant

pub fn to_bits_le(&self) -> Vec<Boolean, Global>

pub fn from_bits_le(bits: &[Boolean]) -> UInt8

pub fn get_value(&self) -> Option<String>

fn result_is_constant(first: &Self, second: &Self) -> bool

Returns true if both Int objects have constant bits

impl PartialEq<UInt8> for UInt8

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

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

This method tests for !=.

impl PartialOrd<UInt8> for UInt8

pub fn partial_cmp(&self, other: &UInt8) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<F> Pow<F, UInt8> for UInt8 where
    F: PrimeField, 

pub fn pow<CS>(
    &self,
    cs: CS,
    other: &UInt8
) -> Result<UInt8, <UInt8 as Pow<F, UInt8>>::ErrorType> where
    CS: ConstraintSystem<F>, 

Bitwise exponentiation of two unsized integers. Reference: /snarkVM/models/src/curves/field.rs

type ErrorType = UnsignedIntegerError

impl<F> Sub<F, UInt8> for UInt8 where
    F: PrimeField, 

pub fn sub_unsafe<CS>(
    &self,
    cs: CS,
    other: &UInt8
) -> Result<UInt8, <UInt8 as Sub<F, UInt8>>::ErrorType> where
    CS: ConstraintSystem<F>, 

Used for division. Evaluates a - b, and when a - b < 0, returns 0.

type ErrorType = UnsignedIntegerError

pub fn sub<CS>(
    &self,
    cs: CS,
    other: &UInt8
) -> Result<UInt8, <UInt8 as Sub<F, UInt8>>::ErrorType> where
    CS: ConstraintSystem<F>, 

impl<F> ToBytesGadget<F> for UInt8 where
    F: Field, 

pub fn to_bytes<CS>(
    &self,
    _cs: CS
) -> Result<Vec<UInt8, Global>, SynthesisError> where
    CS: ConstraintSystem<F>, 

pub fn to_bytes_strict<CS>(
    &self,
    cs: CS
) -> Result<Vec<UInt8, Global>, SynthesisError> where
    CS: ConstraintSystem<F>, 

Additionally checks if the produced list of booleans is ‘valid’.

impl UInt for UInt8

pub fn negate(&self) -> UInt8

Returns the inverse UInt

pub fn rotr(&self, by: usize) -> UInt8

Rotate self bits by size

pub fn addmany<F, CS>(
    cs: CS,
    operands: &[UInt8]
) -> Result<UInt8, SynthesisError> where
    CS: ConstraintSystem<F>,
    F: PrimeField, 

Perform modular addition of several UInt objects.

pub fn mul<F, CS>(
    &self,
    cs: CS,
    other: &UInt8
) -> Result<UInt8, UnsignedIntegerError> where
    CS: ConstraintSystem<F>,
    F: PrimeField, 

Perform Bitwise multiplication of two UInt objects. Reference: https://en.wikipedia.org/wiki/Binary_multiplier

impl<F> Xor<F, UInt8> for UInt8 where
    F: PrimeField, 

pub fn xor<CS>(&self, cs: CS, other: &UInt8) -> Result<UInt8, SynthesisError> where
    CS: ConstraintSystem<F>, 

impl Eq for UInt8