Struct CompileOpts

pub struct CompileOpts {
    pub package: String,
    pub binary: String,
    /* private fields */
}

Options for dynamic compilation of guest programs.

By default, compilation occurs within /tmp. However, the implementation does respect the OUT_DIR environment variable.

Fields

package: String

The (in-workspace) package to build.

binary: String

The binary produced by the build that should be loaded into the zkVM after successful compilation.

Implementations

impl CompileOpts

pub fn new(package: &str) -> Self

Setup options for dynamic compilation.

pub fn new_with_custom_binary(package: &str, binary: &str) -> Self

Setup options for dynamic compilation, using non-default binary name.

pub fn set_debug_build(&mut self, debug: bool)

Set dynamic compilation to build the guest program in a debug profile.

pub fn set_unique_build(&mut self, unique: bool)

Set dynamic compilation to run a unique build that neither overwrites prior builds nor will be overwritten by future builds. May be used to concurrently build different versions of the same binary.

Note: the SDK does not automatically clean or otherwise manage the resultant builds in the output directory.

pub fn set_memlimit(&mut self, memlimit: usize)

Set the amount of memory available to the guest program in mb. For certain provers increasing the memory limit can lead to corresponding increases in the required proving time.

Compilation will fail if this option is set when compiling for use with Jolt, which uses a fixed memory size.

The memory limit can also be set using an argument to the nexus_rt::main macro (e.g., #[nexus_rt::main(memlimit = 16)]). The SDK will not overwrite such a hardcoded value.

Trait Implementations

impl Clone for CompileOpts

fn clone(&self) -> CompileOpts

Returns a copy of the value.

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

Performs copy-assignment from source.