Struct AssignedByte 

pub struct AssignedByte<F: CircuitField>(/* private fields */);

This wrapper type on AssignedNative<F> is designed to enforce type safety on assigned bytes. It prevents the user from creating an AssignedByte without using the designated entry points, which guarantee (with constraints) that the assigned value is indeed in the range [0, 256).

Trait Implementations

impl<F, CoreDecomposition, NativeArith> AssertionInstructions<F, AssignedByte<F>> for NativeGadget<F, CoreDecomposition, NativeArith>

where F: CircuitField, CoreDecomposition: CoreDecompositionInstructions<F>, NativeArith: ArithInstructions<F, AssignedNative<F>>,

The set of AssertionInstructions for bytes.

fn assert_equal( &self, layouter: &mut impl Layouter<F>, byte1: &AssignedByte<F>, byte2: &AssignedByte<F>, ) -> Result<(), Error>

Ensures that the given assigned elements are the same.

fn assert_not_equal( &self, layouter: &mut impl Layouter<F>, byte1: &AssignedByte<F>, byte2: &AssignedByte<F>, ) -> Result<(), Error>

Ensures that the given assigned elements are different.

fn assert_equal_to_fixed( &self, layouter: &mut impl Layouter<F>, byte: &AssignedByte<F>, constant: u8, ) -> Result<(), Error>

Ensures that the given assigned element is equal to the given constant.

fn assert_not_equal_to_fixed( &self, layouter: &mut impl Layouter<F>, byte: &AssignedByte<F>, constant: u8, ) -> Result<(), Error>

Ensures that the given assigned element is different from the given constant.

impl<F, CoreDecomposition, NativeArith> AssignmentInstructions<F, AssignedByte<F>> for NativeGadget<F, CoreDecomposition, NativeArith>

where F: CircuitField, CoreDecomposition: CoreDecompositionInstructions<F>, NativeArith: ArithInstructions<F, AssignedNative<F>>,

The set of circuit instructions for assignment of bytes.

fn assign( &self, layouter: &mut impl Layouter<F>, byte: Value<u8>, ) -> Result<AssignedByte<F>, Error>

Assigns an element as a private input to the circuit.

fn assign_fixed( &self, layouter: &mut impl Layouter<F>, constant: u8, ) -> Result<AssignedByte<F>, Error>

Assigns a fixed (constant) element.

fn assign_many( &self, layouter: &mut impl Layouter<F>, values: &[Value<u8>], ) -> Result<Vec<AssignedByte<F>>, Error>

Assigns several elements as private inputs to the circuit.

fn assign_many_fixed( &self, layouter: &mut impl Layouter<F>, values: &[Assigned::Element], ) -> Result<Vec<Assigned>, Error>

Assigns several elements fixed values to the circuit.

impl<F: Clone + CircuitField> Clone for AssignedByte<F>

fn clone(&self) -> AssignedByte<F>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F, CoreDecomposition, NativeArith> ControlFlowInstructions<F, AssignedByte<F>> for NativeGadget<F, CoreDecomposition, NativeArith>

where F: CircuitField, CoreDecomposition: CoreDecompositionInstructions<F>, NativeArith: ArithInstructions<F, AssignedNative<F>> + ControlFlowInstructions<F, AssignedNative<F>>,

fn select( &self, layouter: &mut impl Layouter<F>, bit: &AssignedBit<F>, x: &AssignedByte<F>, y: &AssignedByte<F>, ) -> Result<AssignedByte<F>, Error>

Returns x if cond = true and y otherwise.

fn cond_swap( &self, layouter: &mut impl Layouter<F>, cond: &AssignedBit<F>, x: &AssignedByte<F>, y: &AssignedByte<F>, ) -> Result<(AssignedByte<F>, AssignedByte<F>), Error>

Swaps two elements x and y only if cond is set to 1.

fn cond_assert_equal( &self, layouter: &mut impl Layouter<F>, cond: &AssignedBit<F>, x: &Assigned, y: &Assigned, ) -> Result<(), Error>

Equality assertion only if cond is set to 1.

impl<F, CoreDecomposition, NativeArith> ConversionInstructions<F, AssignedByte<F>, AssignedCell<F, F>> for NativeGadget<F, CoreDecomposition, NativeArith>

where F: CircuitField, CoreDecomposition: CoreDecompositionInstructions<F>, NativeArith: ArithInstructions<F, AssignedNative<F>>,

Conversion from AssignedByte to AssignedNative.

fn convert_value(&self, x: &u8) -> Option<F>

Converts an AssignedSource::Element into an AssignedTarget::Element, returns None if the conversion failed.

fn convert( &self, _layouter: &mut impl Layouter<F>, byte: &AssignedByte<F>, ) -> Result<AssignedNative<F>, Error>

Converts an AssignedSource into an AssignedTarget.

impl<F, K, P, N> ConversionInstructions<F, AssignedByte<F>, AssignedField<F, K, P>> for FieldChip<F, K, P, N>

where F: CircuitField, K: CircuitField, P: FieldEmulationParams<F, K>, N: NativeInstructions<F>,

fn convert_value(&self, x: &u8) -> Option<K>

Converts an AssignedSource::Element into an AssignedTarget::Element, returns None if the conversion failed.

fn convert( &self, layouter: &mut impl Layouter<F>, x: &AssignedByte<F>, ) -> Result<AssignedField<F, K, P>, Error>

Converts an AssignedSource into an AssignedTarget.

impl<F, CoreDecomposition, NativeArith> ConversionInstructions<F, AssignedCell<F, F>, AssignedByte<F>> for NativeGadget<F, CoreDecomposition, NativeArith>

where F: CircuitField, CoreDecomposition: CoreDecompositionInstructions<F>, NativeArith: ArithInstructions<F, AssignedNative<F>>,

Conversion from AssignedNative to AssignedByte.

fn convert_value(&self, x: &F) -> Option<u8>

Converts an AssignedSource::Element into an AssignedTarget::Element, returns None if the conversion failed.

fn convert( &self, layouter: &mut impl Layouter<F>, x: &AssignedNative<F>, ) -> Result<AssignedByte<F>, Error>

Converts an AssignedSource into an AssignedTarget.

impl<F: Debug + CircuitField> Debug for AssignedByte<F>

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

Formats the value using the given formatter.

impl<F, CoreDecomposition, NativeArith> EqualityInstructions<F, AssignedByte<F>> for NativeGadget<F, CoreDecomposition, NativeArith>

where F: CircuitField, CoreDecomposition: CoreDecompositionInstructions<F>, NativeArith: ArithInstructions<F, AssignedNative<F>> + EqualityInstructions<F, AssignedNative<F>>,

The set of EqualityInstructions for bytes.

fn is_equal( &self, layouter: &mut impl Layouter<F>, byte1: &AssignedByte<F>, byte2: &AssignedByte<F>, ) -> Result<AssignedBit<F>, Error>

Returns 1 if the elements are equal, returns 0 otherwise.

fn is_not_equal( &self, layouter: &mut impl Layouter<F>, byte1: &AssignedByte<F>, byte2: &AssignedByte<F>, ) -> Result<AssignedBit<F>, Error>

Returns 0 if the elements are equal, returns 1 otherwise.

fn is_equal_to_fixed( &self, layouter: &mut impl Layouter<F>, byte: &AssignedByte<F>, constant: u8, ) -> Result<AssignedBit<F>, Error>

Returns 1 iff the given element equals the given constant.

fn is_not_equal_to_fixed( &self, layouter: &mut impl Layouter<F>, byte: &AssignedByte<F>, constant: u8, ) -> Result<AssignedBit<F>, Error>

Returns 1 iff the given element is not equal to the given constant.

impl<F: CircuitField> From<&AssignedByte<F>> for AssignedNative<F>

fn from(value: &AssignedByte<F>) -> Self

Converts to this type from the input type.

impl<F: CircuitField> From<AssignedBit<F>> for AssignedByte<F>

fn from(value: AssignedBit<F>) -> Self

Converts to this type from the input type.

impl<F: CircuitField> From<AssignedByte<F>> for AssignedNative<F>

fn from(value: AssignedByte<F>) -> Self

Converts to this type from the input type.

impl<F: CircuitField> HashInstructions<F, AssignedByte<F>, [AssignedByte<F>; 20]> for RipeMD160Chip<F>

fn hash( &self, layouter: &mut impl Layouter<F>, inputs: &[AssignedByte<F>], ) -> Result<[AssignedByte<F>; 20], Error>

Hash the given input into the designated output type.

impl<F: CircuitField> HashInstructions<F, AssignedByte<F>, [AssignedByte<F>; 32]> for Sha256Chip<F>

fn hash( &self, layouter: &mut impl Layouter<F>, inputs: &[AssignedByte<F>], ) -> Result<[AssignedByte<F>; 32], Error>

Hash the given input into the designated output type.

impl<F: CircuitField> HashInstructions<F, AssignedByte<F>, [AssignedByte<F>; 64]> for Sha512Chip<F>

fn hash( &self, layouter: &mut impl Layouter<F>, inputs: &[AssignedByte<F>], ) -> Result<[AssignedByte<F>; 64], Error>

Hash the given input into the designated output type.

impl<F: CircuitField> InnerValue for AssignedByte<F>

type Element = u8

Represents the unassigned type corresponding to the InnerValue

fn value(&self) -> Value<u8>

Returns the value of the assigned element.

impl<F: CircuitField> Instantiable<F> for AssignedByte<F>

fn as_public_input(element: &u8) -> Vec<F>

This function is the off-circuit analog of crate::instructions::PublicInputInstructions::as_public_input.

fn from_public_input(fields: &[F]) -> Option<u8>

Inverse of Self::as_public_input: reconstructs the element from its public input representation. Returns None if fields does not encode a valid element.

impl<F, CoreDecomposition, NativeArith> PublicInputInstructions<F, AssignedByte<F>> for NativeGadget<F, CoreDecomposition, NativeArith>

where F: CircuitField, CoreDecomposition: CoreDecompositionInstructions<F>, NativeArith: PublicInputInstructions<F, AssignedNative<F>> + ArithInstructions<F, AssignedNative<F>>,

Instructions for constraining bytes as public inputs.

fn as_public_input( &self, _layouter: &mut impl Layouter<F>, assigned: &AssignedByte<F>, ) -> Result<Vec<AssignedNative<F>>, Error>

Returns the cells associated with the given assigned value with the same format as a public input. This function is the in-circuit analog of Instantiable::as_public_input.

fn constrain_as_public_input( &self, layouter: &mut impl Layouter<F>, assigned: &AssignedByte<F>, ) -> Result<(), Error>

Constrains the given assigned value as a public input to the circuit.

fn assign_as_public_input( &self, layouter: &mut impl Layouter<F>, value: Value<u8>, ) -> Result<AssignedByte<F>, Error>

Same as assign, but it immediately constrains the assigned value as a public input. This allows the implementer of this function to skip some in-circuit checks on the structure of the assigned value, which will be guaranteed to hold through the public input bind.

impl<F, CoreDecomposition, NativeArith> UnsafeConversionInstructions<F, AssignedCell<F, F>, AssignedByte<F>> for NativeGadget<F, CoreDecomposition, NativeArith>

where F: CircuitField, CoreDecomposition: CoreDecompositionInstructions<F>, NativeArith: ArithInstructions<F, AssignedNative<F>>,

Unsafe conversion from AssignedNative to AssignedByte.

fn convert_unsafe( &self, _layouter: &mut impl Layouter<F>, x: &AssignedNative<F>, ) -> Result<AssignedByte<F>, Error>

CAUTION: use only if you know what you are doing!

This function converts an AssignedNative to an AssignedByte without adding any constraint to guarantee the “byteness” of the assigned value.

It should be used only when the input x is already guaranteed to be a byte

impl<F: CircuitField, const MAX_LEN: usize> VarHashInstructions<F, MAX_LEN, AssignedByte<F>, [AssignedByte<F>; 32], 64> for VarLenSha256Gadget<F>

fn varhash( &self, layouter: &mut impl Layouter<F>, inputs: &AssignedVector<F, AssignedByte<F>, MAX_LEN, 64>, ) -> Result<[AssignedByte<F>; 32], Error>

Hash the given input into the designated output type.

impl<F: CircuitField> Vectorizable for AssignedByte<F>

const FILLER: u8 = 0u8

Value to fill the space in the buffer that is not occupied with vector data.