Struct GuestOptions

#[non_exhaustive]
pub struct GuestOptions {
    pub features: Vec<String>,
    pub use_docker: Option<DockerOptions>,
    pub kernel: Option<Vec<u8>>,
}

Options defining how to embed a guest package in crate::embed_methods_with_options.

use risc0_build::{DockerOptionsBuilder, GuestOptionsBuilder};

let docker_options = DockerOptionsBuilder::default()
    .root_dir("../../")
    .env(vec![("ENV_VAR".to_string(), "value".to_string())])
    .build()
    .unwrap();

let guest_options = GuestOptionsBuilder::default()
    .features(vec!["my-features".to_string()])
    .use_docker(docker_options)
    .build()
    .unwrap();

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

features: Vec<String>

Features for cargo to build the guest with.

use_docker: Option<DockerOptions>

Use a docker environment for building.

kernel: Option<Vec<u8>>

Override the default kernel ELF to be used for execution.

Implementations

impl GuestOptions

pub fn kernel(&self) -> Vec<u8>

Get the kernel ELF to be used for execution.

Trait Implementations

impl Clone for GuestOptions

fn clone(&self) -> GuestOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GuestOptions

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

Formats the value using the given formatter.

impl Default for GuestOptions

fn default() -> GuestOptions

Returns the “default value” for a type.