Struct Composer

pub struct Composer {
    pub daemon: Docker,
}

The Composer is responsible for managing the OP-UP docker containers.

Fields

daemon: Docker

The Docker daemon client.

Implementations

impl Composer

pub fn new() -> Result<Self>

Create a new instance of the Composer.

pub async fn list_containers( &self, status: Option<&str>, ) -> Result<Vec<ContainerSummary>>

List all the OP-UP docker containers existing on the host.

The containers are filtered by the label com.docker.compose.project=op-up.

This method allows optional filtering by container status: created|restarting|running|removing|paused|exited|dead

pub async fn create_image<T>( &self, opts: CreateImageOptions<'_, T>, ) -> Result<String>

where T: Into<String> + Serialize + Clone + Debug,

Create a Docker image from the specified options.

Returns the ID of the created image.

pub async fn build_image( &self, name: &str, dockerfile: &str, build_context_files: &[(&str, &[u8])], ) -> Result<()>

Build a Docker image from the specified Dockerfile and build context files.

pub async fn create_volume<T>( &self, config: CreateVolumeOptions<T>, ) -> Result<Volume>

where T: Into<String> + Serialize + Eq + Hash,

Creates a Docker volume with the specified options.

pub async fn create_container( &self, name: &str, config: Config<String>, overwrite: bool, ) -> Result<ContainerCreateResponse>

Create a Docker container for the specified OP Stack component

pub async fn start_container(&self, id: &str) -> Result<()>

Start the specified OP Stack component container by ID.

pub async fn stop_container(&self, id: &str) -> Result<()>

Stop the specified OP Stack component container by ID.

pub async fn remove_container(&self, id: &str) -> Result<()>

Remove the specified OP Stack component container by ID.

pub async fn stop_all_containers(&self) -> Result<()>

Stop all OP-UP docker containers at once.

pub async fn purge_all_containers(&self) -> Result<()>

Remove all OP-UP docker containers at once

pub async fn remote_exec( &self, id: &str, cmd: Vec<&str>, ) -> Result<Vec<LogOutput>>

Execute a command on a running container by its ID and return the output.

Trait Implementations

impl Debug for Composer

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

Formats the value using the given formatter.