Struct Configurator 

pub struct Configurator { /* private fields */ }

Configuration of the container

Implementations

impl Configurator

pub fn create(self) -> Container

Create the container

pub fn set_command( self, command: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Set the command for the docker

pub fn set_capture_stdio(self, capture: bool) -> Self

Capture stdin/err/out

pub fn set_interactive(self, interactive: bool) -> Self

Set the docker in interactive mode.

pub fn set_tty(self, tty: bool) -> Self

Set the docker in TTY mode.

pub fn set_privilged(self, privileged: bool) -> Self

👎Deprecated since 0.2.4: please use set_privileged instead

Enable/disable privileged (see docker documentation).

pub fn set_privileged(self, privileged: bool) -> Self

Enable/disable privileged (see docker documentation).

pub fn set_x11_forwarding(self, x11_forwarding: bool) -> Self

Forward X11 to the container

pub fn set_network(self, network: Network) -> Self

Set the network mode

pub fn set_ipc(self, ipc: Ipc, size: Option<&str>) -> Self

Set the IPC mode. Size is optional, for instance “1g”

pub fn mount( self, host_dir: impl Into<String>, container_dir: impl Into<String>, ) -> Self

Mount a drive from the host to the container

pub fn set_username(self, username: impl Into<String>) -> Self

Set the username in the container, this is required for X11 forwarding

pub fn set_env_variable( self, key: impl Into<String>, variable: impl Into<String>, ) -> Self

Set an environment variable

pub fn copy_env_variable_from_host(self, key: impl Into<String>) -> Self

Copy a variable from host environment. Silently fails if the variable is not available in host.

pub fn set_clean_up(self, clean_up: bool) -> Self

Set if the container should be cleaned up after execution (set –rm)

pub fn set_name(self, name: impl Into<String>) -> Self

set the name of the container

pub fn generate_name(self, prefix: impl Into<String>) -> Self

generate a name with the given prefix

pub fn map_port(self, host_port: u16, container_port: u16) -> Self

Map a host port to a container port

pub fn work_directory(self, working_directory: impl Into<String>) -> Self

Set the work directory in the container

pub fn with_ok<T, E>( self, value: Result<T, E>, f: impl FnOnce(Self, T) -> Self, ) -> Self

Convenience function for configuring the container with a value that comes from a result.

pub fn with_some<T>( self, value: Option<T>, f: impl FnOnce(Self, T) -> Self, ) -> Self

Convenience function for configuring the container with a value that comes from an option.

pub fn cond(self, cond: bool, f: impl FnOnce(Self) -> Self) -> Self

Convenience function for configuring the container with a condition. If cond is true, the closure f is executed.

pub fn cond_or( self, cond: bool, f: impl FnOnce(Self) -> Self, g: impl FnOnce(Self) -> Self, ) -> Self

Convenience function for configuring the container with cond. If cond is true, the closure f is executed, otherwise g is executed.

pub fn unwrap_option<T>( self, value: &Option<T>, f: impl FnOnce(Self, &T) -> Self, ) -> Self

If the option is set call the function f. Otherwise do nothing and return self.

pub fn unwrap_option_or<T>( self, value: &Option<T>, f: impl FnOnce(Self, &T) -> Self, g: impl FnOnce(Self) -> Self, ) -> Self

If the option is set call the function f. Otherwise do nothing and return self.

pub fn pull(&self) -> Result<()>

Pull the image.