Struct RunOpt

pub struct RunOpt {

    pub image: String,
    pub env: Vec<(OsString, OsString)>,
    pub detach: bool,
    pub init: bool,
    pub interactive: bool,
    pub name: Option<String>,
    pub network: Option<String>,
    pub user: Option<UserAndGroup>,
    pub publish: Vec<PublishPorts>,
    pub read_only: bool,
    pub remove: bool,
    pub tty: bool,
    pub volumes: Vec<Volume>,
    pub command: Option<PathBuf>,
    pub args: Vec<OsString>,
}

Options for running a container.

Fields

image: String

Container image to run.

env: Vec<(OsString, OsString)>

Set environment variables.

detach: bool

If true, run the container in the background and print container ID. Defaults to false.

init: bool

Run an init inside the container that forwards signals and reaps processes.

interactive: bool

Keep stdin open even if not attached.

name: Option<String>

Optional name to give the container.

network: Option<String>

Connect a container to a network.

user: Option<UserAndGroup>

User (and optionally) group to use inside the container.

publish: Vec<PublishPorts>

Publish ports from the container to the host.

read_only: bool

Mount the container’s root filesystem as read only.

remove: bool

If true, automatically remove the container when it exits. Defaults to false.

tty: bool

Allocate a psuedo-TTY.

volumes: Vec<Volume>

Volumes to mount in the container.

command: Option<PathBuf>

Optional command to run.

args: Vec<OsString>

Optional arguments to pass to the command.

Trait Implementations

impl Clone for RunOpt

fn clone(&self) -> RunOpt

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RunOpt

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

Formats the value using the given formatter.

impl Default for RunOpt

fn default() -> RunOpt

Returns the “default value” for a type.

impl PartialEq for RunOpt

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for RunOpt

impl StructuralPartialEq for RunOpt