[go: up one dir, main page]

dhat 0.3.0

A library for heap profiling and ad hoc profiling with DHAT.
Documentation
Build #493455 2022-01-17 00:31:50
# rustc version
rustc 1.60.0-nightly (ec4bcaac4 2022-01-15)# docs.rs version
docsrs 0.6.0 (a9d9025 2022-01-15)# build log
[INFO] running `Command { std: "docker" "create" "-v" "/home/cratesfyi/workspace/builds/dhat-0.3.0/target:/opt/rustwide/target:rw,Z" "-v" "/home/cratesfyi/workspace/builds/dhat-0.3.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:0cd99ca24d8e8c98e67c542213511d985b8778b5bdcbb160e038429496686047" "/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\", \"-20220115-1.60.0-nightly-ec4bcaac4\", \"--static-root-path\", \"/\", \"--cap-lints\", \"warn\", \"--disable-per-crate-search\"]" "-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] [stdout] 2a5dc0b9965f1bf3bdb213e3a3853bf8dad4147be398027c6ebbc0d70a11a9c4
[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" "2a5dc0b9965f1bf3bdb213e3a3853bf8dad4147be398027c6ebbc0d70a11a9c4", kill_on_drop: false }`
[INFO] [stderr]  Documenting dhat v0.3.0 (/opt/rustwide/workdir)
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:949:1
[INFO] [stderr]     |
[INFO] [stderr] 949 | / /// A type whose lifetime dictates the start and end of profiling.
[INFO] [stderr] 950 | | ///
[INFO] [stderr] 951 | | /// Profiling starts when the first value of this type is created. Profiling
[INFO] [stderr] 952 | | /// stops when (a) this value is dropped or (b) a `dhat` assertion fails,
[INFO] [stderr] 953 | | /// whichever comes first. When that happens, profiling data may be written to
[INFO] [stderr] 954 | | /// file, depending on how the `Profiler` has been configured. Only one
[INFO] [stderr] 955 | | /// `Profiler` can be running at any point in time.
[INFO] [stderr]     | |___________________________________________________^
[INFO] [stderr]     |
[INFO] [stderr] note: the lint level is defined here
[INFO] [stderr]    --> src/lib.rs:2:9
[INFO] [stderr]     |
[INFO] [stderr] 2   | #![deny(rustdoc::missing_doc_code_examples)]
[INFO] [stderr]     |         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]     --> src/lib.rs:963:1
[INFO] [stderr]      |
[INFO] [stderr] 963  | / impl Profiler {
[INFO] [stderr] 964  | |     /// Initiates allocation profiling.
[INFO] [stderr] 965  | |     ///
[INFO] [stderr] 966  | |     /// Typically the first thing in `main`. Its result should be assigned to a
[INFO] [stderr] ...    |
[INFO] [stderr] 1007 | |     }
[INFO] [stderr] 1008 | | }
[INFO] [stderr]      | |_^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:998:5
[INFO] [stderr]     |
[INFO] [stderr] 998 |     /// Creates a new [`ProfilerBuilder`], which defaults to heap profiling.
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]     --> src/lib.rs:1010:1
[INFO] [stderr]      |
[INFO] [stderr] 1010 | / /// A builder for [`Profiler`], for cases beyond the basic ones provided by
[INFO] [stderr] 1011 | | /// [`Profiler`].
[INFO] [stderr] 1012 | | ///
[INFO] [stderr] 1013 | | /// Created with [`Profiler::builder`].
[INFO] [stderr]      | |_______________________________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]     --> src/lib.rs:1023:1
[INFO] [stderr]      |
[INFO] [stderr] 1023 | / impl ProfilerBuilder {
[INFO] [stderr] 1024 | |     /// Requests ad hoc profiling.
[INFO] [stderr] 1025 | |     ///
[INFO] [stderr] 1026 | |     /// # Examples
[INFO] [stderr] ...    |
[INFO] [stderr] 1143 | |     }
[INFO] [stderr] 1144 | | }
[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 | /     /// Creates a [`Profiler`] from the builder and initiates profiling.
[INFO] [stderr] 1107 | |     ///
[INFO] [stderr] 1108 | |     /// # Panics
[INFO] [stderr] 1109 | |     ///
[INFO] [stderr] 1110 | |     /// Panics if another [`Profiler`] is running.
[INFO] [stderr]      | |__________________________________________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]     --> src/lib.rs:1204:1
[INFO] [stderr]      |
[INFO] [stderr] 1204 | / /// A global allocator that tracks allocations and deallocations on behalf of
[INFO] [stderr] 1205 | | /// the [`Profiler`] type.
[INFO] [stderr] 1206 | | ///
[INFO] [stderr] 1207 | | /// It must be set as the global allocator (via `#[global_allocator]`) when
[INFO] [stderr] 1208 | | /// doing heap profiling.
[INFO] [stderr]      | |_________________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]     --> src/lib.rs:1311:1
[INFO] [stderr]      |
[INFO] [stderr] 1311 | / /// Registers an event during ad hoc profiling.
[INFO] [stderr] 1312 | | ///
[INFO] [stderr] 1313 | | /// The meaning of the weight argument is determined by the user. A call to
[INFO] [stderr] 1314 | | /// this function has no effect if a [`Profiler`] is not running or not doing ad
[INFO] [stderr] 1315 | | /// hoc profiling.
[INFO] [stderr]      | |__________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]     --> src/lib.rs:1330:1
[INFO] [stderr]      |
[INFO] [stderr] 1330 | / impl Profiler {
[INFO] [stderr] 1331 | |     fn drop_inner(&mut self, memory_output: Option<&mut String>) {
[INFO] [stderr] 1332 | |         let ignore_allocs = IgnoreAllocs::new();
[INFO] [stderr] 1333 | |         std::assert!(!ignore_allocs.was_already_ignoring_allocs);
[INFO] [stderr] ...    |
[INFO] [stderr] 1353 | |     }
[INFO] [stderr] 1354 | | }
[INFO] [stderr]      | |_^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]     --> src/lib.rs:1591:1
[INFO] [stderr]      |
[INFO] [stderr] 1591 | /// Stats from heap profiling.
[INFO] [stderr]      | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]     --> src/lib.rs:1616:1
[INFO] [stderr]      |
[INFO] [stderr] 1616 | /// Stats from ad hoc profiling.
[INFO] [stderr]      | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]     --> src/lib.rs:1627:1
[INFO] [stderr]      |
[INFO] [stderr] 1627 | / impl HeapStats {
[INFO] [stderr] 1628 | |     /// Gets the current heap stats.
[INFO] [stderr] 1629 | |     ///
[INFO] [stderr] 1630 | |     /// # Panics
[INFO] [stderr] ...    |
[INFO] [stderr] 1648 | |     }
[INFO] [stderr] 1649 | | }
[INFO] [stderr]      | |_^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]     --> src/lib.rs:1628:5
[INFO] [stderr]      |
[INFO] [stderr] 1628 | /     /// Gets the current heap stats.
[INFO] [stderr] 1629 | |     ///
[INFO] [stderr] 1630 | |     /// # Panics
[INFO] [stderr] 1631 | |     ///
[INFO] [stderr] 1632 | |     /// Panics if called when a [`Profiler`] is not running or not doing heap
[INFO] [stderr] 1633 | |     /// profiling.
[INFO] [stderr]      | |__________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]     --> src/lib.rs:1651:1
[INFO] [stderr]      |
[INFO] [stderr] 1651 | / impl AdHocStats {
[INFO] [stderr] 1652 | |     /// Gets the current ad hoc stats.
[INFO] [stderr] 1653 | |     ///
[INFO] [stderr] 1654 | |     /// # Panics
[INFO] [stderr] ...    |
[INFO] [stderr] 1672 | |     }
[INFO] [stderr] 1673 | | }
[INFO] [stderr]      | |_^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]     --> src/lib.rs:1652:5
[INFO] [stderr]      |
[INFO] [stderr] 1652 | /     /// Gets the current ad hoc stats.
[INFO] [stderr] 1653 | |     ///
[INFO] [stderr] 1654 | |     /// # Panics
[INFO] [stderr] 1655 | |     ///
[INFO] [stderr] 1656 | |     /// Panics if called when a [`Profiler`] is not running or not doing ad hoc
[INFO] [stderr] 1657 | |     /// profiling.
[INFO] [stderr]      | |__________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]     --> src/lib.rs:1713:1
[INFO] [stderr]      |
[INFO] [stderr] 1713 | / /// Asserts that an expression is true.
[INFO] [stderr] 1714 | | ///
[INFO] [stderr] 1715 | | /// Like [`std::assert!`], additional format arguments are supported. On
[INFO] [stderr] 1716 | | /// failure, this macro will save the profile data and panic.
[INFO] [stderr] ...    |
[INFO] [stderr] 1723 | | /// - If called after a previous `dhat` assertion has failed with the current
[INFO] [stderr] 1724 | | ///   [`Profiler`]. This is possible if [`std::panic::catch_unwind`] is used.
[INFO] [stderr]      | |_____________________________________________________________________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]     --> src/lib.rs:1739:1
[INFO] [stderr]      |
[INFO] [stderr] 1739 | / /// Asserts that two expressions are equal.
[INFO] [stderr] 1740 | | ///
[INFO] [stderr] 1741 | | /// Like [`std::assert_eq!`], additional format arguments are supported. On
[INFO] [stderr] 1742 | | /// failure, this macro will save the profile data and panic.
[INFO] [stderr] ...    |
[INFO] [stderr] 1749 | | /// - If called after a previous `dhat` assertion has failed with the current
[INFO] [stderr] 1750 | | ///   [`Profiler`]. This is possible if [`std::panic::catch_unwind`] is used.
[INFO] [stderr]      | |_____________________________________________________________________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]     --> src/lib.rs:1771:1
[INFO] [stderr]      |
[INFO] [stderr] 1771 | / /// Asserts that two expressions are not equal.
[INFO] [stderr] 1772 | | ///
[INFO] [stderr] 1773 | | /// Like [`std::assert_ne!`], additional format arguments are supported. On
[INFO] [stderr] 1774 | | /// failure, this macro will save the profile data and panic.
[INFO] [stderr] ...    |
[INFO] [stderr] 1781 | | /// - If called after a previous `dhat` assertion has failed with the current
[INFO] [stderr] 1782 | | ///   [`Profiler`]. This is possible if [`std::panic::catch_unwind`] is used.
[INFO] [stderr]      | |_____________________________________________________________________________^
[INFO] [stderr] 
[INFO] [stderr] warning: `dhat` (lib doc) generated 18 warnings
[INFO] [stderr]     Finished dev [unoptimized + debuginfo] target(s) in 0.96s
[INFO] running `Command { std: "docker" "inspect" "2a5dc0b9965f1bf3bdb213e3a3853bf8dad4147be398027c6ebbc0d70a11a9c4", kill_on_drop: false }`
[INFO] running `Command { std: "docker" "rm" "-f" "2a5dc0b9965f1bf3bdb213e3a3853bf8dad4147be398027c6ebbc0d70a11a9c4", kill_on_drop: false }`
[INFO] [stdout] 2a5dc0b9965f1bf3bdb213e3a3853bf8dad4147be398027c6ebbc0d70a11a9c4