eyre 0.6.12

Flexible concrete Error Reporting type built on std::error::Error with customizable Reports
Documentation
Build #1110513 2024-01-31T16:45:03.989581+00:00
# rustc version
rustc 1.77.0-nightly (cb4d9a190 2024-01-30)# docs.rs version
docsrs 0.6.0 (7667f348 2024-01-17)# build log
[INFO] running `Command { std: "docker" "create" "-v" "/home/cratesfyi/workspace/builds/eyre-0.6.12/target:/opt/rustwide/target:rw,Z" "-v" "/home/cratesfyi/workspace/builds/eyre-0.6.12/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:2788e3201cd34a07e3172128adcd8b3090168a8e3bcc40d7c032b9dda1df7d1c" "/opt/rustwide/cargo-home/bin/cargo" "+nightly" "rustdoc" "--lib" "-Zrustdoc-map" "-Z" "unstable-options" "--config" "build.rustdocflags=[\"--cfg\", \"doc_cfg\", \"-Z\", \"unstable-options\", \"--emit=invocation-specific\", \"--resource-suffix\", \"-20240130-1.77.0-nightly-cb4d9a190\", \"--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] 885f9f7763c480aa9c1173fef3e7fb9a20ee910bb5079c5c1bd149fc5290ba04
[INFO] running `Command { std: "docker" "start" "-a" "885f9f7763c480aa9c1173fef3e7fb9a20ee910bb5079c5c1bd149fc5290ba04", kill_on_drop: false }`
[INFO] [stderr] warning: Rustdoc did not scrape the following examples because they require dev-dependencies: custom_handler, eyre-usage
[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 eyre v0.6.12 (/opt/rustwide/workdir)
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/chain.rs:18:1
[INFO] [stderr]     |
[INFO] [stderr] 18  | / impl<'a> Chain<'a> {
[INFO] [stderr] 19  | |     /// Construct an iterator over a chain of errors via the `source` method
[INFO] [stderr] 20  | |     ///
[INFO] [stderr] 21  | |     /// # Example
[INFO] [stderr] ...   |
[INFO] [stderr] 43  | |     }
[INFO] [stderr] 44  | | }
[INFO] [stderr]     | |_^
[INFO] [stderr]     |
[INFO] [stderr] note: the lint level is defined here
[INFO] [stderr]    --> src/lib.rs:325:10
[INFO] [stderr]     |
[INFO] [stderr] 325 |     warn(rustdoc::missing_doc_code_examples)
[INFO] [stderr]     |          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/error.rs:12:1
[INFO] [stderr]     |
[INFO] [stderr] 12  | / impl Report {
[INFO] [stderr] 13  | |     /// Create a new error object from any error type.
[INFO] [stderr] 14  | |     ///
[INFO] [stderr] 15  | |     /// The error type must be threadsafe and `'static`, so that the `Report`
[INFO] [stderr] ...   |
[INFO] [stderr] 487 | |     }
[INFO] [stderr] 488 | | }
[INFO] [stderr]     | |_^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]   --> src/error.rs:13:5
[INFO] [stderr]    |
[INFO] [stderr] 13 | /     /// Create a new error object from any error type.
[INFO] [stderr] 14 | |     ///
[INFO] [stderr] 15 | |     /// The error type must be threadsafe and `'static`, so that the `Report`
[INFO] [stderr] 16 | |     /// will be as well.
[INFO] [stderr] 17 | |     ///
[INFO] [stderr] 18 | |     /// If the error type does not provide a backtrace, a backtrace will be
[INFO] [stderr] 19 | |     /// created here to ensure that a backtrace exists.
[INFO] [stderr]    | |_______________________________________________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/error.rs:325:5
[INFO] [stderr]     |
[INFO] [stderr] 325 | /     /// The lowest level cause of this error &mdash; this error's cause's
[INFO] [stderr] 326 | |     /// cause's cause etc.
[INFO] [stderr] 327 | |     ///
[INFO] [stderr] 328 | |     /// The root cause is the last error in the iterator produced by
[INFO] [stderr] 329 | |     /// [`chain()`][Report::chain].
[INFO] [stderr]     | |___________________________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/error.rs:339:5
[INFO] [stderr]     |
[INFO] [stderr] 339 | /     /// Returns true if `E` is the type held by this error object.
[INFO] [stderr] 340 | |     ///
[INFO] [stderr] 341 | |     /// For errors constructed from messages, this method returns true if `E` matches the type of
[INFO] [stderr] 342 | |     /// the message `D` **or** the type of the error on which the message has been attached. For
[INFO] [stderr] 343 | |     /// details about the interaction between message and downcasting, [see here].
[INFO] [stderr] 344 | |     ///
[INFO] [stderr] 345 | |     /// [see here]: trait.WrapErr.html#effect-on-downcasting
[INFO] [stderr]     | |____________________________________________________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/error.rs:353:5
[INFO] [stderr]     |
[INFO] [stderr] 353 |     /// Attempt to downcast the error object to a concrete type.
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/error.rs:437:5
[INFO] [stderr]     |
[INFO] [stderr] 437 |     /// Downcast this error object by mutable reference.
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/error.rs:451:5
[INFO] [stderr]     |
[INFO] [stderr] 451 |     /// Get a reference to the Handler for this Report.
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/error.rs:460:5
[INFO] [stderr]     |
[INFO] [stderr] 460 |     /// Get a mutable reference to the Handler for this Report.
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:392:1
[INFO] [stderr]     |
[INFO] [stderr] 392 | / /// The core error reporting type of the library, a wrapper around a dynamic error reporting type.
[INFO] [stderr] 393 | | ///
[INFO] [stderr] 394 | | /// `Report` works a lot like `Box<dyn std::error::Error>`, but with these
[INFO] [stderr] 395 | | /// differences:
[INFO] [stderr] ...   |
[INFO] [stderr] 463 | | /// [`EyreHandler`]: trait.EyreHandler.html
[INFO] [stderr] 464 | | /// [`hook`]: fn.set_hook.html
[INFO] [stderr]     | |______________________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:475:1
[INFO] [stderr]     |
[INFO] [stderr] 475 | /// Error indicating that `set_hook` was unable to install the provided ErrorHook
[INFO] [stderr]     | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:611:1
[INFO] [stderr]     |
[INFO] [stderr] 611 | / impl dyn EyreHandler {
[INFO] [stderr] 612 | |     ///
[INFO] [stderr] 613 | |     pub fn is<T: EyreHandler>(&self) -> bool {
[INFO] [stderr] 614 | |         // Get `TypeId` of the type this function is instantiated with.
[INFO] [stderr] ...   |
[INFO] [stderr] 640 | |     }
[INFO] [stderr] 641 | | }
[INFO] [stderr]     | |_^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:612:5
[INFO] [stderr]     |
[INFO] [stderr] 612 |     ///
[INFO] [stderr]     |     ^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:624:5
[INFO] [stderr]     |
[INFO] [stderr] 624 |     ///
[INFO] [stderr]     |     ^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:633:5
[INFO] [stderr]     |
[INFO] [stderr] 633 |     ///
[INFO] [stderr]     |     ^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:643:1
[INFO] [stderr]     |
[INFO] [stderr] 643 | /// Error Report Handler trait for customizing `eyre::Report`
[INFO] [stderr]     | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:703:5
[INFO] [stderr]     |
[INFO] [stderr] 703 |     /// Override for the `Display` format
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:720:5
[INFO] [stderr]     |
[INFO] [stderr] 720 |     /// Store the location of the caller who constructed this error report
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:725:1
[INFO] [stderr]     |
[INFO] [stderr] 725 | / /// The default provided error report handler for `eyre::Report`.
[INFO] [stderr] 726 | | ///
[INFO] [stderr] 727 | | /// On nightly this supports conditionally capturing a `std::backtrace::Backtrace` if the source
[INFO] [stderr] 728 | | /// error did not already capture one.
[INFO] [stderr]     | |______________________________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:736:1
[INFO] [stderr]     |
[INFO] [stderr] 736 | / impl DefaultHandler {
[INFO] [stderr] 737 | |     /// Manual hook which constructs `DefaultHandler`s.
[INFO] [stderr] 738 | |     ///
[INFO] [stderr] 739 | |     /// # Details
[INFO] [stderr] ...   |
[INFO] [stderr] 773 | |     }
[INFO] [stderr] 774 | | }
[INFO] [stderr]     | |_^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]     --> src/lib.rs:1100:5
[INFO] [stderr]      |
[INFO] [stderr] 1100 |     /// Wrap the error value with a new adhoc error
[INFO] [stderr]      |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]     --> src/lib.rs:1106:5
[INFO] [stderr]      |
[INFO] [stderr] 1106 | /     /// Wrap the error value with a new adhoc error that is evaluated lazily
[INFO] [stderr] 1107 | |     /// only once an error does occur.
[INFO] [stderr]      | |______________________________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]     --> src/lib.rs:1114:5
[INFO] [stderr]      |
[INFO] [stderr] 1114 |     /// Compatibility re-export of wrap_err for interop with `anyhow`
[INFO] [stderr]      |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]     --> src/lib.rs:1120:5
[INFO] [stderr]      |
[INFO] [stderr] 1120 |     /// Compatibility re-export of wrap_err_with for interop with `anyhow`
[INFO] [stderr]      |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]     --> src/lib.rs:1169:5
[INFO] [stderr]      |
[INFO] [stderr] 1169 | /     /// Transform the [`Option<T>`] into a [`Result<T, E>`],
[INFO] [stderr] 1170 | |     /// mapping [`Some(v)`][Option::Some] to [`Ok(v)`][Result::Ok]
[INFO] [stderr] 1171 | |     /// and [`None`] to [`Report`].
[INFO] [stderr] 1172 | |     ///
[INFO] [stderr] ...    |
[INFO] [stderr] 1176 | |     /// For dynamic error messages, use [`ok_or_else`][Option::ok_or_else],
[INFO] [stderr] 1177 | |     /// invoking [`eyre!`] in the closure to perform string interpolation.
[INFO] [stderr]      | |__________________________________________________________________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]     --> src/lib.rs:1227:5
[INFO] [stderr]      |
[INFO] [stderr] 1227 | /     /// Compatibility version of `wrap_err` for creating new errors with new source on `Option`
[INFO] [stderr] 1228 | |     /// when porting from `anyhow`
[INFO] [stderr]      | |__________________________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]     --> src/lib.rs:1234:5
[INFO] [stderr]      |
[INFO] [stderr] 1234 | /     /// Compatibility version of `wrap_err_with` for creating new errors with new source on `Option`
[INFO] [stderr] 1235 | |     /// when porting from `anyhow`
[INFO] [stderr]      | |__________________________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]     --> src/lib.rs:1242:5
[INFO] [stderr]      |
[INFO] [stderr] 1242 |     /// Compatibility re-export of `context` for porting from `anyhow` to `eyre`
[INFO] [stderr]      |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]     --> src/lib.rs:1248:5
[INFO] [stderr]      |
[INFO] [stderr] 1248 |     /// Compatibility re-export of `with_context` for porting from `anyhow` to `eyre`
[INFO] [stderr]      |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]     --> src/lib.rs:1256:1
[INFO] [stderr]      |
[INFO] [stderr] 1256 | / /// Equivalent to Ok::<_, eyre::Error>(value).
[INFO] [stderr] 1257 | | ///
[INFO] [stderr] 1258 | | /// This simplifies creation of an eyre::Result in places where type inference
[INFO] [stderr] 1259 | | /// cannot deduce the `E` type of the result &mdash; without needing to write
[INFO] [stderr] ...    |
[INFO] [stderr] 1272 | | ///    |         consider giving this pattern the explicit type `std::result::Result<i32, E>`, where the type parameter `E` is specified
[INFO] [stderr] 1273 | | /// ```
[INFO] [stderr]      | |_______^
[INFO] [stderr] 
[INFO] [stderr] warning: `eyre` (lib doc) generated 30 warnings
[INFO] [stderr]     Finished dev [unoptimized + debuginfo] target(s) in 0.32s
[INFO] [stderr]    Generated /opt/rustwide/target/x86_64-unknown-linux-gnu/doc/eyre/index.html
[INFO] running `Command { std: "docker" "inspect" "885f9f7763c480aa9c1173fef3e7fb9a20ee910bb5079c5c1bd149fc5290ba04", kill_on_drop: false }`
[INFO] running `Command { std: "docker" "rm" "-f" "885f9f7763c480aa9c1173fef3e7fb9a20ee910bb5079c5c1bd149fc5290ba04", kill_on_drop: false }`
[INFO] [stdout] 885f9f7763c480aa9c1173fef3e7fb9a20ee910bb5079c5c1bd149fc5290ba04