Struct ContainerConfigBuilder

pub struct ContainerConfigBuilder { /* private fields */ }

Builder for ContainerConfig.

Implementations

impl ContainerConfigBuilder

pub fn hostname<VALUE: Into<Option<String>>>( &mut self, value: VALUE, ) -> &mut Self

Hostname.

pub fn domainname<VALUE: Into<Option<String>>>( &mut self, value: VALUE, ) -> &mut Self

Domainname.

pub fn user<VALUE: Into<Option<String>>>(&mut self, value: VALUE) -> &mut Self

User that will run the command(s) inside the container, also support user:group.

pub fn attach_stdin<VALUE: Into<Option<bool>>>( &mut self, value: VALUE, ) -> &mut Self

Attach the standard input, makes possible user interaction.

pub fn attach_stdout<VALUE: Into<Option<bool>>>( &mut self, value: VALUE, ) -> &mut Self

Attach the standard output.

pub fn attach_stderr<VALUE: Into<Option<bool>>>( &mut self, value: VALUE, ) -> &mut Self

Attach the standard error.

pub fn exposed_ports<VALUE: Into<Option<PortSet>>>( &mut self, value: VALUE, ) -> &mut Self

List of exposed ports.

pub fn tty<VALUE: Into<Option<bool>>>(&mut self, value: VALUE) -> &mut Self

Attach standard streams to a tty, including stdin if it is not closed.

pub fn open_stdin<VALUE: Into<Option<bool>>>( &mut self, value: VALUE, ) -> &mut Self

Open stdin.

pub fn stdin_once<VALUE: Into<Option<bool>>>( &mut self, value: VALUE, ) -> &mut Self

If true, close stdin after the 1 attached client disconnects.

pub fn env<VALUE: Into<Option<Vec<String>>>>( &mut self, value: VALUE, ) -> &mut Self

List of environment variable to set in the container.

pub fn cmd<VALUE: Into<Option<Vec<String>>>>( &mut self, value: VALUE, ) -> &mut Self

Command to run when starting the container.

pub fn healthcheck<VALUE: Into<Option<HealthConfig>>>( &mut self, value: VALUE, ) -> &mut Self

Healthcheck describes how to check the container is healthy.

pub fn args_escaped<VALUE: Into<Option<bool>>>( &mut self, value: VALUE, ) -> &mut Self

True if command is already escaped (meaning treat as a command line) (Windows specific).

pub fn image<VALUE: Into<Option<String>>>(&mut self, value: VALUE) -> &mut Self

Name of the image as it was passed by the operator (e.g. could be symbolic).

pub fn volumes<VALUE: Into<Option<HashMap<String, Value>>>>( &mut self, value: VALUE, ) -> &mut Self

List of volumes (mounts) used for the container.

pub fn working_dir<VALUE: Into<Option<String>>>( &mut self, value: VALUE, ) -> &mut Self

Current directory (PWD) in the command will be launched.

pub fn entrypoint<VALUE: Into<Option<Vec<String>>>>( &mut self, value: VALUE, ) -> &mut Self

Entrypoint to run when starting the container.

pub fn network_disabled<VALUE: Into<Option<bool>>>( &mut self, value: VALUE, ) -> &mut Self

Is network disabled.

pub fn mac_address<VALUE: Into<Option<String>>>( &mut self, value: VALUE, ) -> &mut Self

Mac Address of the container.

pub fn on_build<VALUE: Into<Option<Vec<String>>>>( &mut self, value: VALUE, ) -> &mut Self

ONBUILD metadata that were defined on the image Dockerfile.

pub fn labels<VALUE: Into<Option<HashMap<String, String>>>>( &mut self, value: VALUE, ) -> &mut Self

List of labels set to this container.

pub fn stop_signal<VALUE: Into<Option<String>>>( &mut self, value: VALUE, ) -> &mut Self

Signal to stop a container.

pub fn stop_timeout<VALUE: Into<Option<i32>>>( &mut self, value: VALUE, ) -> &mut Self

Timeout (in seconds) to stop a container.

pub fn shell<VALUE: Into<Option<Vec<String>>>>( &mut self, value: VALUE, ) -> &mut Self

Shell for shell-form of RUN, CMD, ENTRYPOINT.

pub fn host_config<VALUE: Into<Option<HostConfig>>>( &mut self, value: VALUE, ) -> &mut Self

Container configuration that depends on the host we are running on.

pub fn networking_config<VALUE: Into<Option<NetworkingConfig>>>( &mut self, value: VALUE, ) -> &mut Self

This container’s networking configuration.

pub fn build(&self) -> Result<ContainerConfig, String>

Builds a new ContainerConfig.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for ContainerConfigBuilder

fn clone(&self) -> ContainerConfigBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for ContainerConfigBuilder

fn default() -> ContainerConfigBuilder

Returns the “default value” for a type.