Struct zkinterface::consumers::workspace::Workspace

pub struct Workspace { /* fields omitted */ }

Workspace finds and reads zkInterface messages from a directory. It supports reading messages one-by-one from large files or from many files. It supports reading from stdin using dash (-) as a special filename.

Example

use zkinterface::{Workspace, WorkspaceSink, Sink, Message};
use zkinterface::producers::examples::*;
use std::path::PathBuf;

// Create an example workspace including multiple constraints files.
let dir = PathBuf::from("local/test_workspace");
let mut sink = WorkspaceSink::new(&dir).unwrap();
sink.push_header(example_circuit_header());
sink.push_witness(example_witness());
sink.push_witness(example_witness());
sink.push_constraints(example_constraints());
sink.push_constraints(example_constraints());

// Iterate over the files and observe the messages.
let mut got = vec![];

let ws = Workspace::from_dir(&dir).unwrap();
for msg in ws.iter_messages() {
    match msg {
        Message::Header(h) => got.push("HEADER"),
        Message::Witness(w) => got.push("WITNESS"),
        Message::ConstraintSystem(cs) => got.push("CONSTRAINTS"),
        _ => {}
    }
}

assert_eq!(got, vec!["HEADER", "WITNESS", "WITNESS", "CONSTRAINTS", "CONSTRAINTS"]);

Implementations

impl Workspace

pub fn from_dir(path: &Path) -> Result<Self>

pub fn from_dirs_and_files(paths: &[PathBuf]) -> Result<Self>

pub fn from_filenames(paths: Vec<PathBuf>) -> Self

pub fn iter_messages<'w>(&'w self) -> impl Iterator<Item = Message> + 'w

pub fn read_all_messages(&self) -> Messages

Trait Implementations

impl Clone for Workspace

fn clone(&self) -> Workspace

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Workspace

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

Formats the value using the given formatter.

impl Default for Workspace

fn default() -> Workspace

Returns the “default value” for a type.

impl Eq for Workspace

impl From<&'_ Workspace> for Messages

fn from(ws: &Workspace) -> Messages

Convert from Flatbuffers messages to owned structure.

impl PartialEq<Workspace> for Workspace

fn eq(&self, other: &Workspace) -> bool

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

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

This method tests for !=.

impl StructuralEq for Workspace

impl StructuralPartialEq for Workspace