Struct DockerOptions

#[non_exhaustive]
pub struct DockerOptions {
    pub root_dir: Option<PathBuf>,
    pub env: Vec<(String, String)>,
    pub docker_container_tag: Option<String>,
}

Options for configuring a docker build environment.

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.

root_dir: Option<PathBuf>

Specify the root directory for docker builds.

The current working directory is used if this option is unspecified.

env: Vec<(String, String)>

Additional environment variables for the build container.

docker_container_tag: Option<String>

Docker container tag to use

Implementations

impl DockerOptions

pub fn root_dir(&self) -> PathBuf

Get the configured root dir, or current working directory if None.

pub fn env(&self) -> Vec<(&str, &str)>

Get the configured custom environment variables.

pub fn docker_container_tag(&self) -> String

Get the docker container tag, or default container tag if none

This value may be set by using the RISC0_DOCKER_CONTAINER_TAG environment variable.

Trait Implementations

impl Clone for DockerOptions

fn clone(&self) -> DockerOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DockerOptions

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

Formats the value using the given formatter.

impl Default for DockerOptions

fn default() -> DockerOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DockerOptions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DockerOptions

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

where __S: Serializer,

Serialize this value into the given Serde serializer.