Documentation

& is a reverse application operator. This provides notational convenience. Its precedence is one higher than that of the forward application operator $, which allows & to be nested in $.

>>> 5 & (+1) & show
"6"

Since: base-4.8.0.0

Unwrap a ResourceT transformer, and call all registered release actions.

Note that there is some reference counting involved due to resourceForkIO. If multiple threads are sharing the same collection of resources, only the last call to runResourceT will deallocate the resources.

NOTE Since version 1.2.0, this function will throw a ResourceCleanupException if any of the cleanup functions throw an exception.

Since: resourcet-0.3.0

Convenient alias for ResourceT IO.

The parsed JSON output of docker inspect command.

Handle to a Docker container.

Handle to a Docker image.

A data type indicating which pipe to scan for a specific log line.

The exception thrown by waitUntilTimeout.

The exception thrown by waitForLine in case the expected log line wasn't found.

A strategy that describes how to asses readiness of a Container. Allows Users to plug in their definition of readiness.

Identifies a container within the Docker runtime. Assigned by docker run.

A description of how to build an Image.

A tag to a Docker image.

Parameters for a running a Docker container.

Docker related functionality is parameterized over this Monad.

Failing to interact with Docker results in this exception being thrown.

Default ContainerRequest. Used as base for every Docker container.

Set the name of a Docker container.

The command to execute inside the Docker container.

Wether to remove the container once exited.

Set the environment for the container.

Set link on the container.

Set exposed ports on the container.

Example:

 redis
     & setExpose [ 6379 ]

Set the waiting strategy on the container.

Runs a Docker container from an Image and ContainerRequest. A finalizer is registered so that the container is aways stopped when it goes out of scope.

Kills a Docker container.

Stops a Docker container.

Remove a Docker container.

Get the logs from a Docker container.

Build the Image referred to by the argument. If the construction of the image is expensive (e.g. a call to fromBuildContext) we don't want to repeatedly build the image. Instead, build can be used to execute the underlying Docker build once and re-use the resulting Image.

Get an Image from a tag.

Build the image from a build path and an optional path to the Dockerfile (default is Dockerfile)

Build a contextless image only from a Dockerfile passed as Text.

waitUntilTimeout n waitUntilReady waits n seconds for the container to be ready. If the container is not ready by then a TimeoutException will be thrown.

Waits until the port of a container is ready to accept connections. This combinator should always be used with waitUntilTimeout.

A low-level primitive that allows scanning the logs for specific log lines that indicate readiness of a container.

The Handles passed to the function argument represent stdout and stderr of the container.

Waits for a specific line to occur in the logs. Throws a UnexpectedEndOfPipe exception in case the desired line can not be found on the logs.

Say you want to find "Ready to accept connections" in the logs on Stdout try:

wairForLogLine Stdout ("Ready to accept connections" `isInfixOf`)

Blocks until the container is ready. waitUntilReady might throw exceptions depending on the used WaitUntilReady on the container.

The image tag assigned by Docker. Uniquely identifies an Image within Docker.

Returns the id of the container.

Returns the underlying image of the container.

Returns the internal release key used for safely shutting down the container. Use this with care. This function is considered an internal detail.

Looks up the ip address of the container.

Looks up an exposed port on the host.

Runs the `docker inspect` command. Memoizes the result.

Image for Redis database.

redis = fromTag "redis:5.0"

Image for Mongo database.

mongo = Tag "mongo:4.0.17"