docker_engine_api 0.1.5

A simple way to interact with the Docker Engine API
Documentation
Build #1830663 2025-03-03 10:38:40

# rustc version rustc 1.87.0-nightly (f4a216d28 2025-03-02)

# docs.rs version docsrs 0.6.0 (d925d3c8 2025-02-27)

# build log [INFO] running `Command { std: "docker" "create" "-v" "/home/cratesfyi/workspace/builds/docker_engine_api-0.1.5/target:/opt/rustwide/target:rw,Z" "-v" "/home/cratesfyi/workspace/builds/docker_engine_api-0.1.5/source:/opt/rustwide/workdir:ro,Z" "-v" "/home/cratesfyi/workspace/cargo-home:/opt/rustwide/cargo-home:ro,Z" "-v" "/home/cratesfyi/workspace/rustup-home:/opt/rustwide/rustup-home:ro,Z" "-e" "SOURCE_DIR=/opt/rustwide/workdir" "-e" "CARGO_TARGET_DIR=/opt/rustwide/target" "-e" "DOCS_RS=1" "-e" "CARGO_HOME=/opt/rustwide/cargo-home" "-e" "RUSTUP_HOME=/opt/rustwide/rustup-home" "-w" "/opt/rustwide/workdir" "-m" "6442450944" "--cpus" "6" "--user" "1001:1001" "--network" "none" "ghcr.io/rust-lang/crates-build-env/linux@sha256:1680c8fbd8dfb46fcd6d22e546df16ab0e007457dc29fcd9e987cdd5077fd1af" "/opt/rustwide/cargo-home/bin/cargo" "+nightly" "rustdoc" "--lib" "-Zrustdoc-map" "--config" "build.rustdocflags=[\"--cfg\", \"docsrs\", \"-Z\", \"unstable-options\", \"--emit=invocation-specific\", \"--resource-suffix\", \"-20250302-1.87.0-nightly-f4a216d28\", \"--static-root-path\", \"/-/rustdoc.static/\", \"--cap-lints\", \"warn\", \"--extern-html-root-takes-precedence\"]" "--offline" "-Zunstable-options" "--config=doc.extern-map.registries.crates-io=\"https://docs.rs/{pkg_name}/{version}/i686-unknown-linux-gnu\"" "-Zrustdoc-scrape-examples" "-j6" "--target" "i686-unknown-linux-gnu", kill_on_drop: false }` [INFO] [stdout] 4f91d4861863d06369fd9603e3159288b5d0a192951de729ff649700f993a553 [INFO] [stderr] WARNING: Your kernel does not support swap limit capabilities or the cgroup is not mounted. Memory limited without swap. [INFO] running `Command { std: "docker" "start" "-a" "4f91d4861863d06369fd9603e3159288b5d0a192951de729ff649700f993a553", kill_on_drop: false }` [INFO] [stderr] warning: target filter specified, but no targets matched; this is a no-op [INFO] [stderr] Documenting docker_engine_api v0.1.5 (/opt/rustwide/workdir) [INFO] [stderr] warning: this URL is not a hyperlink [INFO] [stderr] --> src/containers_service.rs:148:38 [INFO] [stderr] | [INFO] [stderr] 148 | /// See the Docker API refenrece[https://docs.docker.com/engine/api/v1.41/#tag/Container/operation/ContainerCreate] for more informat... [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] | [INFO] [stderr] = note: bare URLs are not automatically turned into clickable links [INFO] [stderr] = note: `#[warn(rustdoc::bare_urls)]` on by default [INFO] [stderr] help: use an automatic link instead [INFO] [stderr] | [INFO] [stderr] 148 | /// See the Docker API refenrece[<https://docs.docker.com/engine/api/v1.41/#tag/Container/operation/ContainerCreate>] for more information. [INFO] [stderr] | + + [INFO] [stderr] [INFO] [stderr] warning: this URL is not a hyperlink [INFO] [stderr] --> src/containers_service.rs:182:38 [INFO] [stderr] | [INFO] [stderr] 182 | /// See the Docker API reference[https://docs.docker.com/engine/api/v1.41/#tag/Container/operation/ContainerInspect] for more informa... [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] | [INFO] [stderr] = note: bare URLs are not automatically turned into clickable links [INFO] [stderr] help: use an automatic link instead [INFO] [stderr] | [INFO] [stderr] 182 | /// See the Docker API reference[<https://docs.docker.com/engine/api/v1.41/#tag/Container/operation/ContainerInspect>] for more information. [INFO] [stderr] | + + [INFO] [stderr] [INFO] [stderr] warning: this URL is not a hyperlink [INFO] [stderr] --> src/containers_service.rs:210:38 [INFO] [stderr] | [INFO] [stderr] 210 | /// See the Docker API reference[https://docs.docker.com/engine/api/v1.41/#tag/Container/operation/ContainerStart] for more information. [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] | [INFO] [stderr] = note: bare URLs are not automatically turned into clickable links [INFO] [stderr] help: use an automatic link instead [INFO] [stderr] | [INFO] [stderr] 210 | /// See the Docker API reference[<https://docs.docker.com/engine/api/v1.41/#tag/Container/operation/ContainerStart>] for more information. [INFO] [stderr] | + + [INFO] [stderr] [INFO] [stderr] warning: this URL is not a hyperlink [INFO] [stderr] --> src/containers_service.rs:237:38 [INFO] [stderr] | [INFO] [stderr] 237 | /// See the Docker API reference[https://docs.docker.com/engine/api/v1.41/#tag/Container/operation/ContainerStop] [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] | [INFO] [stderr] = note: bare URLs are not automatically turned into clickable links [INFO] [stderr] help: use an automatic link instead [INFO] [stderr] | [INFO] [stderr] 237 | /// See the Docker API reference[<https://docs.docker.com/engine/api/v1.41/#tag/Container/operation/ContainerStop>] [INFO] [stderr] | + + [INFO] [stderr] [INFO] [stderr] warning: this URL is not a hyperlink [INFO] [stderr] --> src/containers_service.rs:263:38 [INFO] [stderr] | [INFO] [stderr] 263 | /// See the Docker API reference[https://docs.docker.com/engine/api/v1.41/#tag/Container/operation/ContainerRestart] for more informa... [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] | [INFO] [stderr] = note: bare URLs are not automatically turned into clickable links [INFO] [stderr] help: use an automatic link instead [INFO] [stderr] | [INFO] [stderr] 263 | /// See the Docker API reference[<https://docs.docker.com/engine/api/v1.41/#tag/Container/operation/ContainerRestart>] for more information. [INFO] [stderr] | + + [INFO] [stderr] [INFO] [stderr] warning: this URL is not a hyperlink [INFO] [stderr] --> src/containers_service.rs:289:38 [INFO] [stderr] | [INFO] [stderr] 289 | /// See the Docker API reference[https://docs.docker.com/engine/api/v1.41/#tag/Container/operation/ContainerKill] for more information. [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] | [INFO] [stderr] = note: bare URLs are not automatically turned into clickable links [INFO] [stderr] help: use an automatic link instead [INFO] [stderr] | [INFO] [stderr] 289 | /// See the Docker API reference[<https://docs.docker.com/engine/api/v1.41/#tag/Container/operation/ContainerKill>] for more information. [INFO] [stderr] | + + [INFO] [stderr] [INFO] [stderr] warning: this URL is not a hyperlink [INFO] [stderr] --> src/containers_service.rs:318:38 [INFO] [stderr] | [INFO] [stderr] 318 | /// See the Docker API reference[https://docs.docker.com/engine/api/v1.41/#operation/ContainerDelete] for more information. [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] | [INFO] [stderr] = note: bare URLs are not automatically turned into clickable links [INFO] [stderr] help: use an automatic link instead [INFO] [stderr] | [INFO] [stderr] 318 | /// See the Docker API reference[<https://docs.docker.com/engine/api/v1.41/#operation/ContainerDelete>] for more information. [INFO] [stderr] | + + [INFO] [stderr] [INFO] [stderr] warning: this URL is not a hyperlink [INFO] [stderr] --> src/containers_service.rs:346:38 [INFO] [stderr] | [INFO] [stderr] 346 | /// See the Docker API reference[https://docs.docker.com/engine/api/v1.41/#operation/ContainerLogs] for more information. [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] | [INFO] [stderr] = note: bare URLs are not automatically turned into clickable links [INFO] [stderr] help: use an automatic link instead [INFO] [stderr] | [INFO] [stderr] 346 | /// See the Docker API reference[<https://docs.docker.com/engine/api/v1.41/#operation/ContainerLogs>] for more information. [INFO] [stderr] | + + [INFO] [stderr] [INFO] [stderr] warning: this URL is not a hyperlink [INFO] [stderr] --> src/containers_service.rs:374:38 [INFO] [stderr] | [INFO] [stderr] 374 | /// See the Docker API reference[https://docs.docker.com/engine/api/v1.41/#operation/ContainerListProcesses] for more information. [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] | [INFO] [stderr] = note: bare URLs are not automatically turned into clickable links [INFO] [stderr] help: use an automatic link instead [INFO] [stderr] | [INFO] [stderr] 374 | /// See the Docker API reference[<https://docs.docker.com/engine/api/v1.41/#operation/ContainerListProcesses>] for more information. [INFO] [stderr] | + + [INFO] [stderr] [INFO] [stderr] warning: this URL is not a hyperlink [INFO] [stderr] --> src/containers_service.rs:418:39 [INFO] [stderr] | [INFO] [stderr] 418 | /// See the Docker API reference [https://docs.docker.com/engine/api/v1.41/#tag/Container/operation/ContainerStats] for more informat... [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] | [INFO] [stderr] = note: bare URLs are not automatically turned into clickable links [INFO] [stderr] help: use an automatic link instead [INFO] [stderr] | [INFO] [stderr] 418 | /// See the Docker API reference [<https://docs.docker.com/engine/api/v1.41/#tag/Container/operation/ContainerStats>] for more information. [INFO] [stderr] | + + [INFO] [stderr] [INFO] [stderr] warning: this URL is not a hyperlink [INFO] [stderr] --> src/containers_service.rs:448:39 [INFO] [stderr] | [INFO] [stderr] 448 | /// See the Docker API reference [https://docs.docker.com/engine/api/v1.41/#operation/ContainerResize] for more information. [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] | [INFO] [stderr] = note: bare URLs are not automatically turned into clickable links [INFO] [stderr] help: use an automatic link instead [INFO] [stderr] | [INFO] [stderr] 448 | /// See the Docker API reference [<https://docs.docker.com/engine/api/v1.41/#operation/ContainerResize>] for more information. [INFO] [stderr] | + + [INFO] [stderr] [INFO] [stderr] warning: this URL is not a hyperlink [INFO] [stderr] --> src/containers_service.rs:474:39 [INFO] [stderr] | [INFO] [stderr] 474 | /// See the Docker API reference [https://docs.docker.com/engine/api/v1.41/#operation/ContainerPause] for more information. [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] | [INFO] [stderr] = note: bare URLs are not automatically turned into clickable links [INFO] [stderr] help: use an automatic link instead [INFO] [stderr] | [INFO] [stderr] 474 | /// See the Docker API reference [<https://docs.docker.com/engine/api/v1.41/#operation/ContainerPause>] for more information. [INFO] [stderr] | + + [INFO] [stderr] [INFO] [stderr] warning: this URL is not a hyperlink [INFO] [stderr] --> src/containers_service.rs:500:39 [INFO] [stderr] | [INFO] [stderr] 500 | /// See the Docker API reference [https://docs.docker.com/engine/api/v1.41/#operation/ContainerUnpause] for more information. [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] | [INFO] [stderr] = note: bare URLs are not automatically turned into clickable links [INFO] [stderr] help: use an automatic link instead [INFO] [stderr] | [INFO] [stderr] 500 | /// See the Docker API reference [<https://docs.docker.com/engine/api/v1.41/#operation/ContainerUnpause>] for more information. [INFO] [stderr] | + + [INFO] [stderr] [INFO] [stderr] warning: this URL is not a hyperlink [INFO] [stderr] --> src/containers_service.rs:527:39 [INFO] [stderr] | [INFO] [stderr] 527 | /// See the Docker API reference [https://docs.docker.com/engine/api/v1.41/#operation/ContainerWait] for more information. [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] | [INFO] [stderr] = note: bare URLs are not automatically turned into clickable links [INFO] [stderr] help: use an automatic link instead [INFO] [stderr] | [INFO] [stderr] 527 | /// See the Docker API reference [<https://docs.docker.com/engine/api/v1.41/#operation/ContainerWait>] for more information. [INFO] [stderr] | + + [INFO] [stderr] [INFO] [stderr] warning: this URL is not a hyperlink [INFO] [stderr] --> src/containers_service.rs:554:39 [INFO] [stderr] | [INFO] [stderr] 554 | /// See the Docker API reference [https://docs.docker.com/engine/api/v1.41/#operation/ContainerUpdate] for more information. [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] | [INFO] [stderr] = note: bare URLs are not automatically turned into clickable links [INFO] [stderr] help: use an automatic link instead [INFO] [stderr] | [INFO] [stderr] 554 | /// See the Docker API reference [<https://docs.docker.com/engine/api/v1.41/#operation/ContainerUpdate>] for more information. [INFO] [stderr] | + + [INFO] [stderr] [INFO] [stderr] warning: this URL is not a hyperlink [INFO] [stderr] --> src/containers_service.rs:583:39 [INFO] [stderr] | [INFO] [stderr] 583 | /// See the Docker API reference [https://docs.docker.com/engine/api/v1.41/#operation/ContainerRename] for more information. [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] | [INFO] [stderr] = note: bare URLs are not automatically turned into clickable links [INFO] [stderr] help: use an automatic link instead [INFO] [stderr] | [INFO] [stderr] 583 | /// See the Docker API reference [<https://docs.docker.com/engine/api/v1.41/#operation/ContainerRename>] for more information. [INFO] [stderr] | + + [INFO] [stderr] [INFO] [stderr] warning: this URL is not a hyperlink [INFO] [stderr] --> src/containers_service.rs:605:39 [INFO] [stderr] | [INFO] [stderr] 605 | /// See the Docker API reference [https://docs.docker.com/engine/api/v1.41/#operation/ContainerPrune] for more information. [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] | [INFO] [stderr] = note: bare URLs are not automatically turned into clickable links [INFO] [stderr] help: use an automatic link instead [INFO] [stderr] | [INFO] [stderr] 605 | /// See the Docker API reference [<https://docs.docker.com/engine/api/v1.41/#operation/ContainerPrune>] for more information. [INFO] [stderr] | + + [INFO] [stderr] [INFO] [stderr] warning: `docker_engine_api` (lib doc) generated 17 warnings (run `cargo fix --lib -p docker_engine_api` to apply 17 suggestions) [INFO] [stderr] Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.96s [INFO] [stderr] Generated /opt/rustwide/target/i686-unknown-linux-gnu/doc/docker_engine_api/index.html [INFO] running `Command { std: "docker" "inspect" "4f91d4861863d06369fd9603e3159288b5d0a192951de729ff649700f993a553", kill_on_drop: false }` [INFO] running `Command { std: "docker" "rm" "-f" "4f91d4861863d06369fd9603e3159288b5d0a192951de729ff649700f993a553", kill_on_drop: false }` [INFO] [stdout] 4f91d4861863d06369fd9603e3159288b5d0a192951de729ff649700f993a553