Struct DockerExecutor 

pub struct DockerExecutor { /* private fields */ }

Build a docker image with bollard and start it up

Implementations

impl DockerExecutor

pub fn with_context_path(&mut self, path: impl Into<PathBuf>) -> &mut Self

Set the path to build the context from (default “.”)

pub fn with_workdir(&mut self, path: impl Into<PathBuf>) -> &mut Self

Set the default working directory inside the container (default “/app”)

pub fn retain_on_drop(&mut self, retain: bool) -> &mut Self

Instead of killing the container on drop, retain it for inspection. Default is false.

pub fn clear_env(&mut self) -> &mut Self

Clear the environment variables before starting the service in the container

pub fn remove_env(&mut self, env: impl Into<String>) -> &mut Self

Remove an environment variable from the service in the container

pub fn with_env( &mut self, key: impl Into<String>, value: impl Into<String>, ) -> &mut Self

Set an environment variable for the service in the container

pub fn with_envs( &mut self, envs: impl Into<HashMap<String, String>>, ) -> &mut Self

Set multiple environment variables for the service in the container

pub fn with_default_timeout(&mut self, timeout: Duration) -> &mut Self

Use the provided timeout as the default for every command executed against the container.

pub fn clear_default_timeout(&mut self) -> &mut Self

Remove any default timeout previously configured on this executor.

pub fn with_user(&mut self, user: impl Into<String>) -> &mut Self

Set the user (or user_id:group_id) to run the container as (default None, which means root)

pub fn with_existing_image(&mut self, path: impl Into<String>) -> &mut Self

Start with an existing image (full tag). Will skip building the image, unless you set a new Dockerfile. Note that this requires that the image has the service available as a binary.

pub fn with_image_name(&mut self, name: impl Into<String>) -> &mut Self

Set the name of the image to build (default “docker-executor”)

pub fn with_container_uuid(&mut self, uuid: impl Into<Uuid>) -> &mut Self

Overwrite the uuid that is added as suffix to the running container

pub fn with_dockerfile(&mut self, path: impl Into<PathBuf>) -> &mut Self

Overwrite the dockerfile to use (default “Dockerfile”)

pub async fn start(self) -> Result<RunningDockerExecutor, DockerExecutorError>

Starts the docker executor

Note that on dropping the RunningDockerExecutor, the container will be stopped

Trait Implementations

impl Clone for DockerExecutor

fn clone(&self) -> DockerExecutor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DockerExecutor

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

Formats the value using the given formatter.

impl Default for DockerExecutor

fn default() -> Self

Returns the “default value” for a type.