Struct harbourmaster::ContainerBuilder

pub struct ContainerBuilder { /* fields omitted */ }

Builder struct for fine control over the construction of a Container.

see Container::builder() for example.

Methods

impl ContainerBuilder

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

Set the tag of the docker image. defaults to "latest".

pub fn client(self, client: impl Into<Client>) -> Self

Use an alternative Docker Client to manipulate the Container.ContainerBuilder

This defaults to a globally shared Docker client at the default socket. This should be fine in just about all cases.

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

Set the name of the docker container.

pub fn slug_length(self, length: usize) -> Self

Optionally add an alphanumeric 'slug' to the container name.

In the form "[container name]_XXXX" where XXXX represents the slug.

Useful if you're creating a job lot of containers and you want them to have human readable names, but no collisions.

pub fn expose(self, src_port: u16, host_port: u16, protocol: Protocol) -> Self

Expose a port from the container to the host.

Can be called multiple times to expose multiple ports.

pub fn pull_on_build(self, pull: bool) -> Self

Set whether the client will attempt to pull the image from the internet before running the container. defaults to false.

pub fn build(self) -> impl Future<Item = Container, Error = Error>

Consume the ContainerBuilder and return a future which resolves to the Container (or an error!).