docker-api 0.14.0

Interface to Docker API
Documentation
Build #2577939 2025-10-11 18:31:51

# rustc version rustc 1.92.0-nightly (9725c4baa 2025-10-09)

# docs.rs version docsrs 0.6.0 (f42173de 2025-09-12)

# build log [INFO] running `Command { std: "docker" "create" "-v" "/home/cratesfyi/workspace/builds/docker-api-0.14.0/target:/opt/rustwide/target:rw,Z" "-v" "/home/cratesfyi/workspace/builds/docker-api-0.14.0/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:e90291280db7d1fac5b66fc6dad9f9662629e7365a55743daf9bdf73ebc4ea79" "/opt/rustwide/cargo-home/bin/cargo" "+nightly" "rustdoc" "--lib" "-Zrustdoc-map" "--all-features" "--config" "build.rustdocflags=[\"--cfg\", \"docsrs\", \"--cfg\", \"docsrs\", \"-Z\", \"unstable-options\", \"--emit=invocation-specific\", \"--resource-suffix\", \"-20251009-1.92.0-nightly-9725c4baa\", \"--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}/x86_64-unknown-linux-gnu\"" "-Zrustdoc-scrape-examples" "-j6" "--target" "x86_64-unknown-linux-gnu", kill_on_drop: false }` [INFO] [stderr] WARNING: Your kernel does not support swap limit capabilities or the cgroup is not mounted. Memory limited without swap. [INFO] [stdout] febc112c0bd9e5263d7c0b49cb0cd6b9ef1ca81cd2ff2320463e3d234eee3b9b [INFO] running `Command { std: "docker" "start" "-a" "febc112c0bd9e5263d7c0b49cb0cd6b9ef1ca81cd2ff2320463e3d234eee3b9b", kill_on_drop: false }` [INFO] [stderr] warning: Rustdoc did not scrape the following examples because they require dev-dependencies: common, container, exec, image, network, service, system, volume [INFO] [stderr] If you want Rustdoc to scrape these examples, then add `doc-scrape-examples = true` [INFO] [stderr] to the [[example]] target configuration of at least one example. [INFO] [stderr] warning: target filter specified, but no targets matched; this is a no-op [INFO] [stderr] Documenting docker-api v0.14.0 (/opt/rustwide/workdir) [INFO] [stderr] warning: unresolved link to `TtyMultiplexer` [INFO] [stderr] --> src/builder.rs:107:21 [INFO] [stderr] | [INFO] [stderr] 107 | #[doc = concat!(api_url!($base => $op))] [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] | [INFO] [stderr] ::: src/api/container.rs:43:5 [INFO] [stderr] | [INFO] [stderr] 43 | / api_doc! { Container => Attach [INFO] [stderr] 44 | | | [INFO] [stderr] 45 | | /// Attaches a [`TtyMultiplexer`](TtyMultiplexer) to the container. [INFO] [stderr] 46 | | /// [INFO] [stderr] ... | [INFO] [stderr] 62 | | .await [INFO] [stderr] 63 | | }} [INFO] [stderr] | |______- in this macro invocation [INFO] [stderr] | [INFO] [stderr] = note: the link appears in this line: [INFO] [stderr] [INFO] [stderr] Attaches a [`TtyMultiplexer`](TtyMultiplexer) to the container. [INFO] [stderr] ^^^^^^^^^^^^^^ [INFO] [stderr] = note: no item named `TtyMultiplexer` in scope [INFO] [stderr] = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]` [INFO] [stderr] = note: `#[warn(rustdoc::broken_intra_doc_links)]` on by default [INFO] [stderr] = note: this warning originates in the macro `calculated_doc` which comes from the expansion of the macro `api_doc` (in Nightly builds, run with -Z macro-backtrace for more info) [INFO] [stderr] [INFO] [stderr] warning: unresolved link to `TtyMultiplexer` [INFO] [stderr] --> src/builder.rs:107:21 [INFO] [stderr] | [INFO] [stderr] 107 | #[doc = concat!(api_url!($base => $op))] [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] | [INFO] [stderr] ::: src/api/container.rs:43:5 [INFO] [stderr] | [INFO] [stderr] 43 | / api_doc! { Container => Attach [INFO] [stderr] 44 | | | [INFO] [stderr] 45 | | /// Attaches a [`TtyMultiplexer`](TtyMultiplexer) to the container. [INFO] [stderr] 46 | | /// [INFO] [stderr] ... | [INFO] [stderr] 62 | | .await [INFO] [stderr] 63 | | }} [INFO] [stderr] | |______- in this macro invocation [INFO] [stderr] | [INFO] [stderr] = note: the link appears in this line: [INFO] [stderr] [INFO] [stderr] The [`TtyMultiplexer`](TtyMultiplexer) implements Stream for returning Stdout and Stderr chunks. It also implements [`AsyncWrite`](futures_util::io::AsyncWrite) for writing to Stdin. [INFO] [stderr] ^^^^^^^^^^^^^^ [INFO] [stderr] = note: no item named `TtyMultiplexer` in scope [INFO] [stderr] = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]` [INFO] [stderr] = note: this warning originates in the macro `calculated_doc` which comes from the expansion of the macro `api_doc` (in Nightly builds, run with -Z macro-backtrace for more info) [INFO] [stderr] [INFO] [stderr] warning: unresolved link to `TtyMultiplexer::split` [INFO] [stderr] --> src/api/container.rs:49:88 [INFO] [stderr] | [INFO] [stderr] 49 | /// The multiplexer can be split into its read and write halves with the [`split`](TtyMultiplexer::split) method [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^ no item named `TtyMultiplexer` in scope [INFO] [stderr] [INFO] [stderr] warning: unresolved link to `Image::build_par` [INFO] [stderr] --> src/builder.rs:107:21 [INFO] [stderr] | [INFO] [stderr] 107 | #[doc = concat!(api_url!($base => $op))] [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] | [INFO] [stderr] ::: src/api/image.rs:120:5 [INFO] [stderr] | [INFO] [stderr] 120 | / api_doc! { Image => Build [INFO] [stderr] 121 | | | [INFO] [stderr] 122 | | /// Builds a new image by reading a Dockerfile in a target directory. If speed is [INFO] [stderr] 123 | | /// important consider using [`Image::build_par`](Image::build_par) that utilizes [INFO] [stderr] ... | [INFO] [stderr] 145 | | }} [INFO] [stderr] | |______- in this macro invocation [INFO] [stderr] | [INFO] [stderr] = note: the link appears in this line: [INFO] [stderr] [INFO] [stderr] important consider using [`Image::build_par`](Image::build_par) that utilizes [INFO] [stderr] ^^^^^^^^^^^^^^^^ [INFO] [stderr] = note: the struct `Image` has no field or associated item named `build_par` [INFO] [stderr] = note: this warning originates in the macro `calculated_doc` which comes from the expansion of the macro `api_doc` (in Nightly builds, run with -Z macro-backtrace for more info) [INFO] [stderr] [INFO] [stderr] warning: unresolved link to `Image::build` [INFO] [stderr] --> src/builder.rs:107:21 [INFO] [stderr] | [INFO] [stderr] 107 | #[doc = concat!(api_url!($base => $op))] [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] | [INFO] [stderr] ::: src/api/image.rs:147:5 [INFO] [stderr] | [INFO] [stderr] 147 | / api_doc! { Image => Build [INFO] [stderr] 148 | | | [INFO] [stderr] 149 | | #[cfg(feature = "par-compress")] [INFO] [stderr] 150 | | /// Builds a new image by reading a Dockerfile in a target directory. Uses parallel [INFO] [stderr] ... | [INFO] [stderr] 173 | | }} [INFO] [stderr] | |______- in this macro invocation [INFO] [stderr] | [INFO] [stderr] = note: the link appears in this line: [INFO] [stderr] [INFO] [stderr] [`Image::build`](Image::build). [INFO] [stderr] ^^^^^^^^^^^^ [INFO] [stderr] = note: the struct `Image` has no field or associated item named `build` [INFO] [stderr] = note: this warning originates in the macro `calculated_doc` which comes from the expansion of the macro `api_doc` (in Nightly builds, run with -Z macro-backtrace for more info) [INFO] [stderr] [INFO] [stderr] warning: unresolved link to `ContainerConnectOptsBuilder::ipam_config` [INFO] [stderr] --> src/opts/network.rs:346:25 [INFO] [stderr] | [INFO] [stderr] 346 | /// See [`ipam_config`](ContainerConnectOptsBuilder::ipam_config). [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `ContainerConnectOptsBuilder` in scope [INFO] [stderr] [INFO] [stderr] warning: unresolved link to `EventOpts` [INFO] [stderr] --> src/opts/system.rs:60:41 [INFO] [stderr] | [INFO] [stderr] 60 | /// Builder interface for [`EventOpts`](EventOpts). [INFO] [stderr] | ^^^^^^^^^ no item named `EventOpts` in scope [INFO] [stderr] | [INFO] [stderr] = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]` [INFO] [stderr] [INFO] [stderr] warning: unclosed HTML tag `timestamp` [INFO] [stderr] --> src/opts/container.rs:701:61 [INFO] [stderr] | [INFO] [stderr] 701 | /// Prune containers created before this timestamp. The <timestamp> can be Unix timestamps, [INFO] [stderr] | ^^^^^^^^^^^ [INFO] [stderr] | [INFO] [stderr] = note: `#[warn(rustdoc::invalid_html_tags)]` on by default [INFO] [stderr] [INFO] [stderr] warning: unclosed HTML tag `timestamp` [INFO] [stderr] --> src/opts/image.rs:498:57 [INFO] [stderr] | [INFO] [stderr] 498 | /// Prune images created before this timestamp. The <timestamp> can be Unix timestamps, [INFO] [stderr] | ^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: unclosed HTML tag `timestamp` [INFO] [stderr] --> src/opts/network.rs:388:59 [INFO] [stderr] | [INFO] [stderr] 388 | /// Prune networks created before this timestamp. The <timestamp> can be Unix timestamps, [INFO] [stderr] | ^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: `docker-api` (lib doc) generated 10 warnings [INFO] [stderr] Finished `dev` profile [unoptimized + debuginfo] target(s) in 1.91s [INFO] [stderr] Generated /opt/rustwide/target/x86_64-unknown-linux-gnu/doc/docker_api/index.html [INFO] running `Command { std: "docker" "inspect" "febc112c0bd9e5263d7c0b49cb0cd6b9ef1ca81cd2ff2320463e3d234eee3b9b", kill_on_drop: false }` [INFO] running `Command { std: "docker" "rm" "-f" "febc112c0bd9e5263d7c0b49cb0cd6b9ef1ca81cd2ff2320463e3d234eee3b9b", kill_on_drop: false }` [INFO] [stdout] febc112c0bd9e5263d7c0b49cb0cd6b9ef1ca81cd2ff2320463e3d234eee3b9b