Struct risc0_zkvm::ExecutorEnvBuilder

pub struct ExecutorEnvBuilder<'a> { /* private fields */ }

A builder pattern used to construct an ExecutorEnv.

Implementations

impl<'a> ExecutorEnvBuilder<'a>

pub fn build(&mut self) -> Result<ExecutorEnv<'a>>

Finalize this builder to construct an ExecutorEnv.

Example

use risc0_zkvm::ExecutorEnv;

let env = ExecutorEnv::builder().build().unwrap();

pub fn segment_limit_po2(&mut self, limit: usize) -> &mut Self

Set a segment limit, specified in powers of 2 cycles.

Given value must be between risc0_zkp::MIN_CYCLES_PO2 and risc0_zkp::MAX_CYCLES_PO2 (inclusive).

pub fn session_limit(&mut self, limit: Option<usize>) -> &mut Self

Set a session limit, specified in number of cycles.

Example

use risc0_zkvm::ExecutorEnv;

let env = ExecutorEnv::builder()
    .session_limit(Some(32 * 1024 * 1024)) // 32M cycles
    .build()
    .unwrap();

pub fn env_vars(&mut self, vars: HashMap<String, String>) -> &mut Self

Add environment variables to the guest environment.

Example

use std::collections::HashMap;
use risc0_zkvm::ExecutorEnv;

let mut vars = HashMap::new();
vars.insert("VAR1".to_string(), "SOME_VALUE".to_string());
vars.insert("VAR2".to_string(), "SOME_VALUE".to_string());

let env = ExecutorEnv::builder()
    .env_vars(vars)
    .build()
    .unwrap();

pub fn env_var(&mut self, name: &str, val: &str) -> &mut Self

Add an environment variable to the guest environment.

Example

use risc0_zkvm::ExecutorEnv;

let env = ExecutorEnv::builder()
    .env_var("VAR1", "SOME_VALUE")
    .build()
    .unwrap();

pub fn add_input<T: Pod>(&mut self, slice: &[T]) -> &mut Self

Add initial input that can be read by the guest from stdin.

Calling add_input iteratively concatenates inputs; the guest can access each input using consecutive reads.

Example

use risc0_zkvm::ExecutorEnv;
use risc0_zkvm::serde::to_vec;

let a: u64 = 400;
let b: u64 = 200;

let env = ExecutorEnv::builder()
    .add_input(&to_vec(&a).unwrap())
    .add_input(&to_vec(&b).unwrap())
    .build()
    .unwrap();

pub fn stdin(&mut self, reader: impl Read + 'a) -> &mut Self

Add a posix-style standard input.

pub fn stdout(&mut self, writer: impl Write + 'a) -> &mut Self

Add a posix-style standard output.

pub fn stderr(&mut self, writer: impl Write + 'a) -> &mut Self

Add a posix-style standard error.

pub fn read_fd(&mut self, fd: u32, reader: impl BufRead + 'a) -> &mut Self

Add a posix-style file descriptor for reading.

pub fn write_fd(&mut self, fd: u32, writer: impl Write + 'a) -> &mut Self

Add a posix-style file descriptor for writing.

pub fn slice_io( &mut self, channel: &str, handler: impl SliceIo + 'a ) -> &mut Self

Add a handler for simple I/O handling.

pub fn io_callback<C: AsRef<str>>( &mut self, channel: C, callback: impl Fn(Bytes) -> Result<Bytes> + 'a ) -> &mut Self

Add a handler for simple I/O handling.

pub fn trace_callback( &mut self, callback: impl FnMut(TraceEvent) -> Result<()> + 'a ) -> &mut Self

Add a callback handler for raw trace messages.

Trait Implementations

impl<'a> Clone for ExecutorEnvBuilder<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Default for ExecutorEnvBuilder<'a>

fn default() -> ExecutorEnvBuilder<'a>

Returns the “default value” for a type.