Struct zkinterface::zkinterface_generated::zkinterface::CircuitHeader

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

A description of a circuit or sub-circuit. This can be a complete circuit ready for proving, or a part of a circuit being built.

Fields

_tab: Table<'a>

Implementations

impl<'a> CircuitHeader<'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 CircuitHeaderArgs<'args>
) -> WIPOffset<CircuitHeader<'bldr>>

pub const VT_INSTANCE_VARIABLES: VOffsetT

pub const VT_FREE_VARIABLE_ID: VOffsetT

pub const VT_FIELD_MAXIMUM: VOffsetT

pub const VT_CONFIGURATION: VOffsetT

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

Instance variables. This is also called public inputs to the circuit.

• Variables are allocated by the sender of this message.
• The same structure must be provided for R1CS and witness generations.
• Values may be omitted in some contexts, such as in a preprocessing phase.
• During witness generation, variables must be assigned values.
• In the particular context of a gadget call, instance_variables holds the inputs to the gadget, i.e. variables allocated by the caller that the gadget can refer to. In the context of a gadget response, it holds the outputs of the gadget, i.e. variables allocated by the gadget that the caller can refer to.

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 field_maximum(&self) -> Option<&'a [u8]>

The largest element of the finite field used by the current system. A canonical little-endian representation of the field order minus one. 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 instance_variables.info.

Trait Implementations

impl<'a> Clone for CircuitHeader<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for CircuitHeader<'a>

impl<'a> Debug for CircuitHeader<'a>

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

Formats the value using the given formatter.

impl<'a> Follow<'a> for CircuitHeader<'a>

type Inner = CircuitHeader<'a>

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

impl<'a> From<CircuitHeader<'a>> for CircuitHeader

fn from(fb_header: CircuitHeader<'_>) -> CircuitHeader

Convert from Flatbuffers references to owned structure.

impl<'a> PartialEq<CircuitHeader<'a>> for CircuitHeader<'a>

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

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

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

This method tests for !=.

impl<'a> StructuralPartialEq for CircuitHeader<'a>