# vv9k/docker-api-rs architecture

> Architecture diagram of the GitHub repository vv9k/docker-api-rs, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/vv9k/docker-api-rs
- Repository: https://github.com/vv9k/docker-api-rs

## Overview

##### Specific Elements

a) Client Configuration
- Builder pattern configuration options
- TLS configuration options (optional feature)

b) API Models
- A section showing the model structures (from src/models.rs)
- Relationship with docker-api-stubs generation

c) Options Handling
- How it relates to each API endpoint

##### Important Details to Highlight

- Feature flags (swarm, tls, chrono)
- API version support (v1.42/v1.43)
- Connection handling
- Streaming capabilities
- Error propagation

##### Architectural Patterns to Emphasize

- Builder pattern for Docker client configuration
- Module organization (api, opts, models)
- Error handling strategy
- Feature toggles implementation

- Feature flags
- Version compatibility

Remember to indicate the asynchronous nature of the operations and how the library handles streaming responses from the Docker daemon, as these are crucial aspects of the implementation.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Client_Layer
        Docker["Docker Client"]:::core
        Builder["Builder Pattern"]:::core
        click Docker "https://github.com/vv9k/docker-api-rs/blob/master/src/docker.rs"
        click Builder "https://github.com/vv9k/docker-api-rs/blob/master/src/builder.rs"
    end

    subgraph API_Layer
        subgraph Core_API
            Container["Container API"]:::api
            Image["Image API"]:::api
            Network["Network API"]:::api
            Volume["Volume API"]:::api
            Exec["Exec API"]:::api
            System["System API"]:::api
            click Container "https://github.com/vv9k/docker-api-rs/blob/master/src/api/container.rs"
            click Image "https://github.com/vv9k/docker-api-rs/blob/master/src/api/image.rs"
            click Network "https://github.com/vv9k/docker-api-rs/blob/master/src/api/network.rs"
            click Volume "https://github.com/vv9k/docker-api-rs/blob/master/src/api/volume.rs"
            click Exec "https://github.com/vv9k/docker-api-rs/blob/master/src/api/exec.rs"
            click System "https://github.com/vv9k/docker-api-rs/blob/master/src/api/system.rs"
        end

        subgraph Swarm_API
            Swarm["Swarm API"]:::swarm
            Node["Node API"]:::swarm
            Service["Service API"]:::swarm
            Task["Task API"]:::swarm
            Secret["Secret API"]:::swarm
            Config["Config API"]:::swarm
            Plugin["Plugin API"]:::swarm
            click Swarm "https://github.com/vv9k/docker-api-rs/blob/master/src/api/swarm.rs"
            click Node "https://github.com/vv9k/docker-api-rs/blob/master/src/api/node.rs"
            click Service "https://github.com/vv9k/docker-api-rs/blob/master/src/api/service.rs"
            click Task "https://github.com/vv9k/docker-api-rs/blob/master/src/api/task.rs"
            click Secret "https://github.com/vv9k/docker-api-rs/blob/master/src/api/secret.rs"
            click Config "https://github.com/vv9k/docker-api-rs/blob/master/src/api/config.rs"
            click Plugin "https://github.com/vv9k/docker-api-rs/blob/master/src/api/plugin.rs"
        end

        subgraph Options_Handling
            ContainerOpts["Container Options"]:::opts
            ImageOpts["Image Options"]:::opts
            NetworkOpts["Network Options"]:::opts
            VolumeOpts["Volume Options"]:::opts
            ExecOpts["Exec Options"]:::opts
            SystemOpts["System Options"]:::opts
            SwarmOpts["Swarm Options"]:::opts
            click ContainerOpts "https://github.com/vv9k/docker-api-rs/blob/master/src/opts/container.rs"
            click ImageOpts "https://github.com/vv9k/docker-api-rs/blob/master/src/opts/image.rs"
            click NetworkOpts "https://github.com/vv9k/docker-api-rs/blob/master/src/opts/network.rs"
            click VolumeOpts "https://github.com/vv9k/docker-api-rs/blob/master/src/opts/volume.rs"
            click ExecOpts "https://github.com/vv9k/docker-api-rs/blob/master/src/opts/exec.rs"
            click SystemOpts "https://github.com/vv9k/docker-api-rs/blob/master/src/opts/system.rs"
            click SwarmOpts "https://github.com/vv9k/docker-api-rs/blob/master/src/opts/swarm.rs"
        end
    end

    subgraph Transport_Layer
        Models["API Models"]:::models
        ErrorHandling["Error Handling"]:::error
        Streaming["Streaming"]:::stream
        Transport["Transport (HTTP/HTTPS)"]:::transport
        click Models "https://github.com/vv9k/docker-api-rs/blob/master/src/models.rs"
        click ErrorHandling "https://github.com/vv9k/docker-api-rs/blob/master/src/errors.rs"
        click Streaming "https://github.com/vv9k/docker-api-rs/blob/master/src/stream.rs"
    end

    Docker --> Builder
    Builder --> Transport

    %% Core API connections
    Docker --> Container & Image & Network & Volume & Exec & System
    Container --> ContainerOpts
    Image --> ImageOpts
    Network --> NetworkOpts
    Volume --> VolumeOpts
    Exec --> ExecOpts
    System --> SystemOpts

    %% Swarm API connections
    Docker -.-> Swarm & Node & Service & Task & Secret & Config & Plugin
    Swarm --> SwarmOpts

    %% Transport Layer connections
    Container & Image & Network & Volume & Exec & System --> Transport
    Swarm & Node & Service & Task & Secret & Config & Plugin --> Transport
    Transport --> Models
    Transport --> ErrorHandling
    Transport --> Streaming

    %% Styles
    classDef core fill:#2196F3,stroke:#1565C0,color:white
    classDef api fill:#4CAF50,stroke:#2E7D32,color:white
    classDef swarm fill:#FFC107,stroke:#FFA000,color:black
    classDef opts fill:#9C27B0,stroke:#7B1FA2,color:white
    classDef models fill:#00BCD4,stroke:#0097A7,color:white
    classDef error fill:#F44336,stroke:#D32F2F,color:white
    classDef stream fill:#FF9800,stroke:#F57C00,color:white
    classDef transport fill:#607D8B,stroke:#455A64,color:white

    %% Legend
    subgraph Legend
        L1["Core Components"]:::core
        L2["API Endpoints"]:::api
        L3["Swarm Features"]:::swarm
        L4["Options"]:::opts
        L5["Models"]:::models
        L6["Error Handling"]:::error
        L7["Streaming"]:::stream
        L8["Transport"]:::transport
    end
```
