firec 0.2.0

Rust API to interact with Firecracker
Documentation
Build #595145 2022-07-18 12:19:01
# rustc version
rustc 1.64.0-nightly (263edd43c 2022-07-17)# docs.rs version
docsrs 0.6.0 (19b354a 2022-07-16)# build log
[INFO] running `Command { std: "docker" "create" "-v" "/home/cratesfyi/workspace/builds/firec-0.2.0/target:/opt/rustwide/target:rw,Z" "-v" "/home/cratesfyi/workspace/builds/firec-0.2.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" "3221225472" "--cpus" "3" "--user" "1001:1001" "--network" "none" "ghcr.io/rust-lang/crates-build-env/linux@sha256:ecb52c4cf6672b83cc996368a05b4a059042425f2b6ba9cd23a06cdead5d8d70" "/opt/rustwide/cargo-home/bin/cargo" "+nightly" "rustdoc" "--lib" "-Zrustdoc-map" "-Z" "unstable-options" "--config" "build.rustdocflags=[\"-Z\", \"unstable-options\", \"--emit=invocation-specific\", \"--resource-suffix\", \"-20220717-1.64.0-nightly-263edd43c\", \"--static-root-path\", \"/\", \"--cap-lints\", \"warn\", \"--disable-per-crate-search\", \"--extern-html-root-takes-precedence\"]" "-Zunstable-options" "--config=doc.extern-map.registries.crates-io=\"https://docs.rs/{pkg_name}/{version}/x86_64-unknown-linux-gnu\"" "-j3" "--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] f3b8e2db41d6ed38c1eb6ff24722392e145c47ebae12428650a4330680ee1e94
[INFO] running `Command { std: "docker" "start" "-a" "f3b8e2db41d6ed38c1eb6ff24722392e145c47ebae12428650a4330680ee1e94", kill_on_drop: false }`
[INFO] [stderr]  Documenting firec v0.2.0 (/opt/rustwide/workdir)
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]  --> src/config/mod.rs:1:1
[INFO] [stderr]   |
[INFO] [stderr] 1 | //! VMM configuration.
[INFO] [stderr]   | ^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]   |
[INFO] [stderr] note: the lint level is defined here
[INFO] [stderr]  --> src/lib.rs:4:23
[INFO] [stderr]   |
[INFO] [stderr] 4 | #![warn(missing_docs, rustdoc::missing_doc_code_examples, unreachable_pub)]
[INFO] [stderr]   |                       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]   --> src/config/mod.rs:14:1
[INFO] [stderr]    |
[INFO] [stderr] 14 | /// Network configuration.
[INFO] [stderr]    | ^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]  --> src/config/network.rs:3:1
[INFO] [stderr]   |
[INFO] [stderr] 3 | /// Network configuration.
[INFO] [stderr]   | ^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]   --> src/config/network.rs:10:1
[INFO] [stderr]    |
[INFO] [stderr] 10 | / impl<'i> Interface<'i> {
[INFO] [stderr] 11 | |     /// Create a new `Interface` instance.
[INFO] [stderr] 12 | |     pub fn new<H, V>(host_if_name: H, vm_if_name: V) -> Self
[INFO] [stderr] 13 | |     where
[INFO] [stderr] ...  |
[INFO] [stderr] 31 | |     }
[INFO] [stderr] 32 | | }
[INFO] [stderr]    | |_^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]   --> src/config/network.rs:11:5
[INFO] [stderr]    |
[INFO] [stderr] 11 |     /// Create a new `Interface` instance.
[INFO] [stderr]    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]   --> src/config/network.rs:23:5
[INFO] [stderr]    |
[INFO] [stderr] 23 |     /// The name of the host interface.
[INFO] [stderr]    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]   --> src/config/network.rs:28:5
[INFO] [stderr]    |
[INFO] [stderr] 28 |     /// The interface name in the VM.
[INFO] [stderr]    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]   --> src/config/mod.rs:27:1
[INFO] [stderr]    |
[INFO] [stderr] 27 | /// VMM configuration.
[INFO] [stderr]    | ^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/config/mod.rs:59:1
[INFO] [stderr]     |
[INFO] [stderr] 59  | / impl<'c> Config<'c> {
[INFO] [stderr] 60  | |     /// Create a new `Builder` instance.
[INFO] [stderr] 61  | |     ///
[INFO] [stderr] 62  | |     /// # Arguments
[INFO] [stderr] ...   |
[INFO] [stderr] 218 | |     }
[INFO] [stderr] 219 | | }
[INFO] [stderr]     | |_^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]   --> src/config/mod.rs:60:5
[INFO] [stderr]    |
[INFO] [stderr] 60 | /     /// Create a new `Builder` instance.
[INFO] [stderr] 61 | |     ///
[INFO] [stderr] 62 | |     /// # Arguments
[INFO] [stderr] 63 | |     ///
[INFO] [stderr] 64 | |     /// `vm_id` - The ID of the VM. It's used as the Firecracker's instance ID. Pass `None` to
[INFO] [stderr] 65 | |     ///           generate a random ID.
[INFO] [stderr] 66 | |     /// `src_kernel_image_path`: The path to the kernel image, that must be an uncompressed ELF image.
[INFO] [stderr]    | |______________________________________________________________________________________________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/config/mod.rs:111:5
[INFO] [stderr]     |
[INFO] [stderr] 111 |     /// The socket path.
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/config/mod.rs:116:5
[INFO] [stderr]     |
[INFO] [stderr] 116 |     /// The socket path in chroot location.
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/config/mod.rs:123:5
[INFO] [stderr]     |
[INFO] [stderr] 123 |     /// The log path.
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/config/mod.rs:128:5
[INFO] [stderr]     |
[INFO] [stderr] 128 |     /// The log fifo path.
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/config/mod.rs:133:5
[INFO] [stderr]     |
[INFO] [stderr] 133 |     /// The metrics path.
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/config/mod.rs:138:5
[INFO] [stderr]     |
[INFO] [stderr] 138 |     /// The metrics fifo path.
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/config/mod.rs:143:5
[INFO] [stderr]     |
[INFO] [stderr] 143 | /     /// The source kernel image path.
[INFO] [stderr] 144 | |     ///
[INFO] [stderr] 145 | |     /// This is the path given by the application. It's transfered to the chroot directory by
[INFO] [stderr] 146 | |     /// [`crate::Machine::create`]. The path inside the chroot can be queried using
[INFO] [stderr] 147 | |     /// [`Config::kernel_image_path`].
[INFO] [stderr]     | |______________________________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/config/mod.rs:152:5
[INFO] [stderr]     |
[INFO] [stderr] 152 |     /// The kernel image path in chroot location.
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/config/mod.rs:157:5
[INFO] [stderr]     |
[INFO] [stderr] 157 | /     /// The source initrd path.
[INFO] [stderr] 158 | |     ///
[INFO] [stderr] 159 | |     /// This is the path given by the application. It's transfered to the chroot directory by
[INFO] [stderr] 160 | |     /// [`crate::Machine::create`]. The path inside the chroot can be queried using
[INFO] [stderr] 161 | |     /// [`Config::initrd_image_path`].
[INFO] [stderr]     | |______________________________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/config/mod.rs:166:5
[INFO] [stderr]     |
[INFO] [stderr] 166 |     /// The initrd path in chroot location.
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/config/mod.rs:180:5
[INFO] [stderr]     |
[INFO] [stderr] 180 |     /// The kernel arguments.
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/config/mod.rs:185:5
[INFO] [stderr]     |
[INFO] [stderr] 185 |     /// The drives.
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/config/mod.rs:190:5
[INFO] [stderr]     |
[INFO] [stderr] 190 |     /// The machine configuration.
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/config/mod.rs:195:5
[INFO] [stderr]     |
[INFO] [stderr] 195 |     /// The jailer configuration.
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/config/mod.rs:200:5
[INFO] [stderr]     |
[INFO] [stderr] 200 |     /// The VM ID.
[INFO] [stderr]     |     ^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/config/mod.rs:205:5
[INFO] [stderr]     |
[INFO] [stderr] 205 |     /// The network namespace path.
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/config/mod.rs:210:5
[INFO] [stderr]     |
[INFO] [stderr] 210 |     /// The network interfaces.
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/config/mod.rs:221:1
[INFO] [stderr]     |
[INFO] [stderr] 221 | /// The boot source for the microVM.
[INFO] [stderr]     | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/config/mod.rs:233:1
[INFO] [stderr]     |
[INFO] [stderr] 233 | /// defines the verbosity of Firecracker logging.
[INFO] [stderr]     | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/config/mod.rs:248:1
[INFO] [stderr]     |
[INFO] [stderr] 248 | /// Configuration builder.
[INFO] [stderr]     | ^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/config/mod.rs:252:1
[INFO] [stderr]     |
[INFO] [stderr] 252 | / impl<'c> Builder<'c> {
[INFO] [stderr] 253 | |     /// Set the file path where the Firecracker control socket should be created.
[INFO] [stderr] 254 | |     pub fn socket_path<P>(mut self, socket_path: P) -> Self
[INFO] [stderr] 255 | |     where
[INFO] [stderr] ...   |
[INFO] [stderr] 363 | |     }
[INFO] [stderr] 364 | | }
[INFO] [stderr]     | |_^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/config/mod.rs:253:5
[INFO] [stderr]     |
[INFO] [stderr] 253 |     /// Set the file path where the Firecracker control socket should be created.
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/config/mod.rs:262:5
[INFO] [stderr]     |
[INFO] [stderr] 262 |     /// Set the Firecracker log path.
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/config/mod.rs:271:5
[INFO] [stderr]     |
[INFO] [stderr] 271 |     /// Set the Firecracker log named-pipe path.
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/config/mod.rs:280:5
[INFO] [stderr]     |
[INFO] [stderr] 280 |     /// Set the verbosity of Firecracker logging.
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/config/mod.rs:286:5
[INFO] [stderr]     |
[INFO] [stderr] 286 |     /// Set the Firecracker metrics path.
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/config/mod.rs:295:5
[INFO] [stderr]     |
[INFO] [stderr] 295 |     /// Set the Firecracker metrics named-pipe path.
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/config/mod.rs:304:5
[INFO] [stderr]     |
[INFO] [stderr] 304 |     /// Set the initrd image path.
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/config/mod.rs:313:5
[INFO] [stderr]     |
[INFO] [stderr] 313 |     /// Set the command-line arguments that should be passed to the kernel.
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/config/mod.rs:322:5
[INFO] [stderr]     |
[INFO] [stderr] 322 |     /// Add a drive.
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/config/mod.rs:331:5
[INFO] [stderr]     |
[INFO] [stderr] 331 |     /// Set the Firecracker microVM process configuration builder.
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/config/mod.rs:336:5
[INFO] [stderr]     |
[INFO] [stderr] 336 |     /// Create the jailer process configuration builder.
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/config/mod.rs:341:5
[INFO] [stderr]     |
[INFO] [stderr] 341 | /     /// Set the path to a network namespace handle.
[INFO] [stderr] 342 | |     ///
[INFO] [stderr] 343 | |     /// If specified, the application will use this to join the associated network namespace.
[INFO] [stderr]     | |_____________________________________________________________________________________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/config/mod.rs:352:5
[INFO] [stderr]     |
[INFO] [stderr] 352 | /     /// Add a network interface.
[INFO] [stderr] 353 | |     ///
[INFO] [stderr] 354 | |     /// Add a tap device that should be made available to the microVM.
[INFO] [stderr]     | |______________________________________________________________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/config/mod.rs:360:5
[INFO] [stderr]     |
[INFO] [stderr] 360 |     /// Build the configuration.
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `Config::initrd_image_path`
[INFO] [stderr]    --> src/config/mod.rs:161:11
[INFO] [stderr]     |
[INFO] [stderr] 161 |     /// [`Config::initrd_image_path`].
[INFO] [stderr]     |           ^^^^^^^^^^^^^^^^^^^^^^^^^ the struct `Config` has no field or associated item named `initrd_image_path`
[INFO] [stderr]     |
[INFO] [stderr]     = note: `#[warn(rustdoc::broken_intra_doc_links)]` on by default
[INFO] [stderr] 
[INFO] [stderr] warning: `firec` (lib doc) generated 46 warnings
[INFO] [stderr]     Finished dev [unoptimized + debuginfo] target(s) in 1.58s
[INFO] running `Command { std: "docker" "inspect" "f3b8e2db41d6ed38c1eb6ff24722392e145c47ebae12428650a4330680ee1e94", kill_on_drop: false }`
[INFO] running `Command { std: "docker" "rm" "-f" "f3b8e2db41d6ed38c1eb6ff24722392e145c47ebae12428650a4330680ee1e94", kill_on_drop: false }`
[INFO] [stdout] f3b8e2db41d6ed38c1eb6ff24722392e145c47ebae12428650a4330680ee1e94