Struct zkinterface::zkinterface_generated::zkinterface::Circuit

pub struct Circuit<'a> {
    pub _tab: Table<'a>,
}

Fields

_tab: Table<'a>

Methods

impl<'a> Circuit<'a>

pub fn init_from_table(table: Table<'a>) -> Self

pub fn create<'bldr: 'args, 'args: 'mut_bldr, 'mut_bldr>(
    _fbb: &'mut_bldr mut FlatBufferBuilder<'bldr>,
    args: &'args CircuitArgs<'args>
) -> WIPOffset<Circuit<'bldr>>

pub const VT_CONNECTIONS: VOffsetT

pub const VT_FREE_VARIABLE_ID: VOffsetT

pub const VT_R1CS_GENERATION: VOffsetT

pub const VT_WITNESS_GENERATION: VOffsetT

pub const VT_FIELD_ORDER: VOffsetT

pub const VT_CONFIGURATION: VOffsetT

pub fn connections(&self) -> Option<Variables<'a>>

Variables to use as connections to the sub-circuit.

• Variables to use as input connections to the gadget.
• Or variables to use as output connections from the gadget.
• Variables are allocated by the sender of this message.
• The same structure must be provided for R1CS and witness generations.
• If witness_generation=true, variables must be assigned values.

pub fn free_variable_id(&self) -> u64

A variable ID greater than all IDs allocated by the sender of this message. The recipient of this message can allocate new IDs >= free_variable_id.

pub fn r1cs_generation(&self) -> bool

Whether a constraint system is being generated. Provide constraints in R1CSConstraints messages.

pub fn witness_generation(&self) -> bool

Whether a witness is being generated. Provide the witness in connections.values and Witness messages.

pub fn field_order(&self) -> Option<&'a [u8]>

The order of the finite field used by the current system. A number in canonical little-endian representation. See Variables.values below.

pub fn configuration(&self) -> Option<Vector<'a, ForwardsUOffset<KeyValue<'a>>>>

Optional: Any custom parameter that may influence the circuit construction.

Example: function_name, if a gadget supports multiple function variants. Example: the depth of a Merkle tree. Counter-example: a Merkle path is not config and belongs in connections.info.

Trait Implementations

impl<'a> Copy for Circuit<'a>

impl<'a> PartialEq<Circuit<'a>> for Circuit<'a>

fn eq(&self, other: &Circuit<'a>) -> bool

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

fn ne(&self, other: &Circuit<'a>) -> bool

This method tests for !=.

impl<'a> Clone for Circuit<'a>

fn clone(&self) -> Circuit<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> From<Circuit<'a>> for CircuitOwned

fn from(circuit: Circuit) -> CircuitOwned

Performs the conversion.

impl<'a> Debug for Circuit<'a>

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

Formats the value using the given formatter.

impl<'a> Follow<'a> for Circuit<'a>

type Inner = Circuit<'a>

fn follow(buf: &'a [u8], loc: usize) -> Self::Inner