Struct FunctionInput

pub struct FunctionInput<F> {
    input: ConstantOrWitnessEnum<F>,
    num_bits: u32,
}

Input to a black box call

Fields

input: ConstantOrWitnessEnum<F>

The actual input value

num_bits: u32

A constant representing the bit size of the input value Some functions will not use all of the witness So we need to supply how many bits of the witness is needed

Implementations

impl<F> FunctionInput<F>

pub fn to_witness(&self) -> Witness

pub fn input(self) -> ConstantOrWitnessEnum<F>

pub fn input_ref(&self) -> &ConstantOrWitnessEnum<F>

pub fn num_bits(&self) -> u32

pub fn witness(witness: Witness, num_bits: u32) -> FunctionInput<F>

pub fn is_constant(&self) -> bool

impl<F: AcirField> FunctionInput<F>

pub fn constant( value: F, max_bits: u32, ) -> Result<FunctionInput<F>, InvalidInputBitSize>

Trait Implementations

impl<F: Clone> Clone for FunctionInput<F>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug> Debug for FunctionInput<F>

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

Formats the value using the given formatter.

impl<'de, F> Deserialize<'de> for FunctionInput<F>

where F: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<F: Display> Display for FunctionInput<F>

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

Formats the value using the given formatter.

impl<F: Hash> Hash for FunctionInput<F>

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<F: PartialEq> PartialEq for FunctionInput<F>

fn eq(&self, other: &FunctionInput<F>) -> 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<F> ProtoCodec<FunctionInput<F>, FunctionInput> for ProtoSchema<F>

where F: AcirField,

fn encode(value: &FunctionInput<F>) -> FunctionInput

Convert domain type T to protobuf representation R.

fn decode(value: &FunctionInput) -> Result<FunctionInput<F>>

Try to convert protobuf representation R to domain type T.

fn encode_some(value: &T) -> Option<R>

Encode a field as Some.

fn encode_vec<'a, I>(values: I) -> Vec<R>

where I: IntoIterator<Item = &'a T>, T: 'a,

Encode multiple values as a vector.

fn decode_wrap(value: &R, msg: &'static str) -> Result<T, Report>

Decode a field and attach the name of the field if it fails.

fn decode_vec(values: &[R]) -> Result<Vec<T>, Report>

Decode multiple values into a vector.

fn decode_vec_wrap(values: &[R], msg: &'static str) -> Result<Vec<T>, Report>

Decode multiple values into a vector, attaching a field name to any errors.

fn decode_arr<const N: usize>(values: &[R]) -> Result<[T; N], Report>

Decode a fixed size array.

fn decode_arr_wrap<const N: usize>( values: &[R], msg: &'static str, ) -> Result<[T; N], Report>

Decode a fixed size array, attaching a field name to any errors

fn decode_box_arr<const N: usize>(values: &[R]) -> Result<Box<[T; N]>, Report>

Decode a boxed fixed size array.

fn decode_box_arr_wrap<const N: usize>( values: &[R], msg: &'static str, ) -> Result<Box<[T; N]>, Report>

Decode a boxed fixed size array, attaching a field name to any errors

fn decode_some(value: &Option<R>) -> Result<T, Report>

Decode an optional field as a required one; fails if it’s None.

fn decode_some_wrap(value: &Option<R>, msg: &'static str) -> Result<T, Report>

Decode an optional field as a required one, attaching a field name to any errors. Returns error if the field is missing.

fn decode_opt_wrap( value: &Option<R>, msg: &'static str, ) -> Result<Option<T>, Report>

Decode an optional field, attaching a field name to any errors. Return None if the field is missing.

fn serialize_to_vec(value: &T) -> Vec<u8>

where R: Message,

Encode a domain type to protobuf and serialize it to bytes.

fn deserialize_from_slice(buf: &[u8]) -> Result<T, Report>

where R: Message + Default,

Deserialize a buffer into protobuf and then decode into the domain type.

impl<F> Serialize for FunctionInput<F>

where F: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<F: Copy> Copy for FunctionInput<F>

impl<F: Eq> Eq for FunctionInput<F>

impl<F> StructuralPartialEq for FunctionInput<F>