Enum Input 

pub enum Input<N>
where
    N: Network,
{
    Constant(Field<N>, Option<Plaintext<N>>),
    Public(Field<N>, Option<Plaintext<N>>),
    Private(Field<N>, Option<Ciphertext<N>>),
    Record(Field<N>, Field<N>),
    ExternalRecord(Field<N>),
    DynamicRecord(Field<N>),
    RecordWithDynamicID(Field<N>, Field<N>, Field<N>),
    ExternalRecordWithDynamicID(Field<N>, Field<N>),
}

The transition input.

Variants

Constant(Field<N>, Option<Plaintext<N>>)

The plaintext hash and (optional) plaintext.

Public(Field<N>, Option<Plaintext<N>>)

The plaintext hash and (optional) plaintext.

Private(Field<N>, Option<Ciphertext<N>>)

The ciphertext hash and (optional) ciphertext.

Record(Field<N>, Field<N>)

The serial number and tag of the record.

ExternalRecord(Field<N>)

The hash of the external record’s (function_id, record, tvk, input index).

DynamicRecord(Field<N>)

The hash of the dynamic record’s (function_id, record, tvk, input index).

RecordWithDynamicID(Field<N>, Field<N>, Field<N>)

The serial number, tag, and dynamic ID of a record input in a dynamic call transition. The dynamic_id is computed from hash(function_id, record, tvk, index). From the caller’s perspective, this appears as DynamicRecord(dynamic_id).

ExternalRecordWithDynamicID(Field<N>, Field<N>)

The external record hash and dynamic ID of an external record input in a dynamic call transition. The dynamic_id is computed from hash(function_id, record, tvk, index). From the caller’s perspective, this appears as DynamicRecord(dynamic_id).

Implementations

impl<N> Input<N>

where N: Network,

pub const fn variant(&self) -> u8

Returns the variant of the input.

pub const fn id(&self) -> &Field<N>

Returns the ID of the input.

pub fn to_transition_leaf(&self, index: u8) -> TransitionLeaf<N>

Returns the input as a transition leaf. Note: RecordWithDynamicID uses leaf variant 3 (same as Record) with version 2. Note: ExternalRecordWithDynamicID uses leaf variant 4 (same as ExternalRecord) with version 2.

pub const fn tag(&self) -> Option<&Field<N>>

Returns the tag, if the input is a record.

pub fn into_tag(self) -> Option<Field<N>>

Returns the tag, if the input is a record, and consumes self.

pub const fn serial_number(&self) -> Option<&Field<N>>

Returns the serial number, if the input is a record.

pub fn into_serial_number(self) -> Option<Field<N>>

Returns the serial number, if the input is a record, and consumes self.

pub fn verifier_inputs(&self) -> impl Iterator<Item = <N as Environment>::Field>

Returns the public verifier inputs for the proof.

pub const fn dynamic_id(&self) -> Option<&Field<N>>

Returns the dynamic ID, if the input carries one.

pub fn to_caller_input(&self) -> Input<N>

Returns the input from the caller’s perspective. This converts internal variants (like RecordWithDynamicID) to what the caller would see (like DynamicRecord).

pub fn verify( &self, function_id: Field<N>, tcm: &Field<N>, index: usize, ) -> bool

Returns true if the input is well-formed. If the optional value exists, this method checks that it hashes to the input ID.

pub fn is_type(&self, expected_value_type: &ValueType<N>) -> bool

Returns true if the input matches the expected value type.

pub fn valid_as_argument( &self, callee_value_type: &ValueType<N>, is_dynamic: Option<bool>, ) -> bool

Returns true if the input matches the given value type as seen by the callee. Record, ExternalRecord, DynamicRecord, RecordWithDynamicID and ExternalRecordWithDynamicID inputs are handled according to the value of is_dynamic:

• Some(true) enforces type correspondence assuming the inputs refer to a dynamic call.
• Some(false) enforces it assuming a static call.
• None is flexible and makes no assumption about the type of call: both dynamic-call and static-call matching patterns return true.

For inputs of an invalid type according to is_dynamic, this function returns false regardless of the value type.

Trait Implementations

impl<N> Clone for Input<N>

where N: Clone + Network,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<N> Debug for Input<N>

where N: Network,

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

Prints the input as a JSON-string.

impl<'de, N> Deserialize<'de> for Input<N>

where N: Network,

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

where D: Deserializer<'de>,

Deserializes the transition input from a string or bytes.

impl<N> Display for Input<N>

where N: Network,

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

Displays the input as a JSON-string.

impl<N> Eq for Input<N>

where N: Eq + Network,

impl<N> FromBytes for Input<N>

where N: Network,

fn read_le<R>(reader: R) -> Result<Input<N>, Error>

where R: Read,

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

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

where Self: Sized,

Same behavior as Self::from_bytes_le but avoids costly checks. This shall only be called when deserializing from a trusted source, such as local storage.

fn read_le_unchecked<R>(reader: R) -> Result<Self, Error>

where R: Read, Self: Sized,

Same behavior as Self::read_le but avoids costly checks. This shall only be called when deserializing from a trusted source, such as local storage.

fn read_le_with_unchecked<R>(reader: R, unchecked: bool) -> Result<Self, Error>

where R: Read, Self: Sized,

Helper function that deserializes either unchecked or checked based on the given boolean flag.

impl<N> FromStr for Input<N>

where N: Network,

fn from_str(input: &str) -> Result<Input<N>, <Input<N> as FromStr>::Err>

Initializes the input from a JSON-string.

type Err = Error

The associated error which can be returned from parsing.

impl<N> PartialEq for Input<N>

where N: PartialEq + Network,

fn eq(&self, other: &Input<N>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<N> Serialize for Input<N>

where N: Network,

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

where S: Serializer,

Serializes the transition input into string or bytes.

impl<N> StructuralPartialEq for Input<N>

where N: PartialEq + Network,

impl<N> ToBytes for Input<N>

where N: Network,

fn write_le<W>(&self, writer: W) -> Result<(), Error>

where W: Write,

Writes the input to a buffer.

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

where Self: Sized,

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