Struct ContainerConfig 

pub struct ContainerConfig<'l> { /* private fields */ }

Create a new instance of the ContainerConfig struct with the given parameters.

Examples

Creating a new configuration using the derived builder:

 use docker_utils::*;

    let config = ContainerConfig::builder()
        .name("test_container")
        .image("test_image")
        .tag("latest")
        .url("0.0.0.0")
        .connection_port(8080)
        .reuse_container(true)
        .keep_configuration(true)
        .wait_strategy(WaitStrategy::NoWait)
        .build();

Implementations

impl<'l> ContainerConfig<'l>

pub fn builder() -> ContainerConfigBuilder<'l>

Create an instance of ContainerConfig using the builder syntax

impl<'l> ContainerConfig<'l>

pub const fn new( name: &'l str, image: &'l str, tag: &'l str, url: &'l str, connection_port: u16, additional_ports: Option<&'l [u16]>, additional_env_vars: Option<&'l [&'l str]>, platform: Option<&'l str>, reuse_container: bool, keep_configuration: bool, wait_strategy: WaitStrategy, ) -> Self

Create a new instance of the ContainerConfig struct with the given parameters.

Arguments

• name - The name of the container.
• image - The image to use for the container.
• tag - The tag of the image.
• url - The default URL of the container. Usually 0.0.0.0
• connection_port - The port number for the main connection i.e. 80 for a webserver.
• additional_ports - An optional array of additional ports to publish.
• platform - An optional platform string in case the container image is not multi-arch.
• reuse_container - A boolean flag indicating whether to reuse an existing container if found.
• keep_configuration - A boolean flag indication whether to keep the configuration upon every environment setup. If set to true, the same configuration will be used across all environment setups. If false, each setup will re-create all tables and import data.,
• wait_strategy - The wait strategy to use for the container.

Examples

Creating a new configuration using the constructor:

use docker_utils::*;

    let config =  ContainerConfig::new(
        "test_container",
        "test_image",
        "latest",
        "0.0.0.0",
        8080,
        Some(&[8081, 8082]),
        Some(&["ENV_VAR=VALUE", "DEBUG=true"]),
        Some("linux/amd64"),
        true,
        false,
        WaitStrategy::default(), // NoWait is the default wait strategy
    );

Returns

Returns a new instance of the ContainerConfig struct.

impl<'l> ContainerConfig<'l>

pub const fn name(&self) -> &'l str

pub fn container_image(&self) -> String

pub fn container_name(&self) -> String

pub const fn url(&self) -> &'l str

pub const fn connection_port(&self) -> u16

pub const fn additional_ports(&self) -> Option<&'l [u16]>

pub const fn additional_env_vars(&self) -> Option<&'l [&'l str]>

pub const fn platform(&self) -> Option<&'l str>

pub const fn reuse_container(&self) -> bool

pub const fn keep_configuration(&self) -> bool

pub const fn wait_strategy(&self) -> &WaitStrategy

pub const fn image(&self) -> &'l str

pub const fn tag(&self) -> &'l str

Trait Implementations

impl<'l> Clone for ContainerConfig<'l>

fn clone(&self) -> ContainerConfig<'l>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'l> Debug for ContainerConfig<'l>

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

Formats the value using the given formatter.

impl<'l> Default for ContainerConfig<'l>

fn default() -> ContainerConfig<'l>

Returns the “default value” for a type.

impl Display for ContainerConfig<'_>

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

Formats the value using the given formatter.

impl<'l> Hash for ContainerConfig<'l>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'l> Ord for ContainerConfig<'l>

fn cmp(&self, other: &ContainerConfig<'l>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'l> PartialEq for ContainerConfig<'l>

fn eq(&self, other: &ContainerConfig<'l>) -> 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<'l> PartialOrd for ContainerConfig<'l>

fn partial_cmp(&self, other: &ContainerConfig<'l>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'l> Eq for ContainerConfig<'l>

impl<'l> StructuralPartialEq for ContainerConfig<'l>