Struct CircuitHeader

pub struct CircuitHeader {
    pub instance_variables: Variables,
    pub free_variable_id: u64,
    pub field_maximum: Option<Vec<u8>>,
    pub configuration: Option<Vec<KeyValue>>,
}

Fields

instance_variables: Variables

free_variable_id: u64

field_maximum: Option<Vec<u8>>

configuration: Option<Vec<KeyValue>>

Implementations

impl CircuitHeader

pub fn list_witness_ids(&self) -> Vec<u64>

Enumerate the IDs of witness variables based on a header.

Example

let header = zkinterface::producers::examples::example_circuit_header();
let witness_ids = header.list_witness_ids();
assert_eq!(witness_ids, vec![4, 5]);

pub fn with_instance_values(self, vars: Variables) -> Result<Self>

pub fn simple_inputs(num_inputs: u64) -> CircuitHeader

pub fn simple_outputs( num_inputs: u64, num_outputs: u64, num_locals: u64, ) -> CircuitHeader

pub fn build<'bldr: 'args, 'args: 'mut_bldr, 'mut_bldr>( &'args self, builder: &'mut_bldr mut FlatBufferBuilder<'bldr>, ) -> WIPOffset<Root<'bldr>>

Add this structure into a Flatbuffers message builder.

pub fn write_into(&self, writer: &mut impl Write) -> Result<()>

Writes this circuit header as a Flatbuffers message into the provided buffer.

Examples

let mut buf = Vec::<u8>::new();
let header = zkinterface::CircuitHeader::default();
header.write_into(&mut buf).unwrap();
assert!(buf.len() > 0);

Trait Implementations

impl Clone for CircuitHeader

fn clone(&self) -> CircuitHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CircuitHeader

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

Formats the value using the given formatter.

impl Default for CircuitHeader

fn default() -> CircuitHeader

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CircuitHeader

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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

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

Convert from Flatbuffers references to owned structure.

impl PartialEq for CircuitHeader

fn eq(&self, other: &CircuitHeader) -> 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 Serialize for CircuitHeader

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> TryFrom<&'a [u8]> for CircuitHeader

type Error = Box<dyn Error>

The type returned in the event of a conversion error.

fn try_from(buffer: &'a [u8]) -> Result<Self>

Performs the conversion.

impl Eq for CircuitHeader

impl StructuralPartialEq for CircuitHeader