prometheus-http-api 0.2.0

API to interact with Prometheus HTTP API
Documentation
Build #549210 2022-04-27 15:03:24
# rustc version
rustc 1.62.0-nightly (082e4ca49 2022-04-26)# docs.rs version
docsrs 0.6.0 (ff301c9 2022-04-27)# build log
[INFO] running `Command { std: "docker" "create" "-v" "/home/cratesfyi/workspace/builds/prometheus-http-api-0.2.0/target:/opt/rustwide/target:rw,Z" "-v" "/home/cratesfyi/workspace/builds/prometheus-http-api-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:d190cb871061d98bc6d0581d85cb2ecb09a0f8a142ba5463de30be9999fc3251" "/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\", \"-20220426-1.62.0-nightly-082e4ca49\", \"--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] 5000965c17b288a17a0290608a3bad638ab4f788137712388b867cf8978cac34
[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" "5000965c17b288a17a0290608a3bad638ab4f788137712388b867cf8978cac34", kill_on_drop: false }`
[INFO] [stderr]  Documenting prometheus-http-api v0.2.0 (/opt/rustwide/workdir)
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:166:1
[INFO] [stderr]     |
[INFO] [stderr] 166 | /// An instant query to send to Prometheus
[INFO] [stderr]     | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr]     |
[INFO] [stderr] note: the lint level is defined here
[INFO] [stderr]    --> src/lib.rs:34:9
[INFO] [stderr]     |
[INFO] [stderr] 34  | #![warn(rustdoc::missing_doc_code_examples)]
[INFO] [stderr]     |         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:177:1
[INFO] [stderr]     |
[INFO] [stderr] 177 | / impl InstantQuery {
[INFO] [stderr] 178 | |     /// Initializes an Instant query with optional fields set to None
[INFO] [stderr] 179 | |     pub fn new(query: &str) -> Self {
[INFO] [stderr] 180 | |         Self {
[INFO] [stderr] ...   |
[INFO] [stderr] 216 | |     }
[INFO] [stderr] 217 | | }
[INFO] [stderr]     | |_^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:178:5
[INFO] [stderr]     |
[INFO] [stderr] 178 |     /// Initializes an Instant query with optional fields set to None
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:187:5
[INFO] [stderr]     |
[INFO] [stderr] 187 |     /// Builder method to set the query timeout
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:193:5
[INFO] [stderr]     |
[INFO] [stderr] 193 |     /// Builder method to set the query timeout
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:199:5
[INFO] [stderr]     |
[INFO] [stderr] 199 | /     /// Transforms the typed query into HTTP GET query params, it contains a pre-built `base` that
[INFO] [stderr] 200 | |     /// may use an HTTP path  prefix if configured.
[INFO] [stderr]     | |___________________________________________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:219:1
[INFO] [stderr]     |
[INFO] [stderr] 219 | /// A range query to send to Prometheus
[INFO] [stderr]     | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:234:1
[INFO] [stderr]     |
[INFO] [stderr] 234 | / impl RangeQuery {
[INFO] [stderr] 235 | |     /// Initializes a Range query with optional fields set to None
[INFO] [stderr] 236 | |     pub fn new(query: &str, start: u64, end: u64, step: f64) -> Self {
[INFO] [stderr] 237 | |         Self {
[INFO] [stderr] ...   |
[INFO] [stderr] 269 | |     }
[INFO] [stderr] 270 | | }
[INFO] [stderr]     | |_^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:235:5
[INFO] [stderr]     |
[INFO] [stderr] 235 |     /// Initializes a Range query with optional fields set to None
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:246:5
[INFO] [stderr]     |
[INFO] [stderr] 246 |     /// Builder method to set the query timeout
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:252:5
[INFO] [stderr]     |
[INFO] [stderr] 252 | /     /// Transforms the typed query into HTTP GET query params, it contains a pre-built `base` that
[INFO] [stderr] 253 | |     /// may use an HTTP path  prefix if configured.
[INFO] [stderr]     | |___________________________________________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:272:1
[INFO] [stderr]     |
[INFO] [stderr] 272 | /// A query to the Prometheus HTTP API
[INFO] [stderr]     | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:281:1
[INFO] [stderr]     |
[INFO] [stderr] 281 | / impl Query {
[INFO] [stderr] 282 | |     /// Transforms the typed query into HTTP GET query params
[INFO] [stderr] 283 | |     pub fn as_query_params(&self, prefix: Option<String>) -> String {
[INFO] [stderr] 284 | |         let mut base = if let Some(prefix) = prefix {
[INFO] [stderr] ...   |
[INFO] [stderr] 304 | |     }
[INFO] [stderr] 305 | | }
[INFO] [stderr]     | |_^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:282:5
[INFO] [stderr]     |
[INFO] [stderr] 282 |     /// Transforms the typed query into HTTP GET query params
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:298:5
[INFO] [stderr]     |
[INFO] [stderr] 298 |     /// Returns the timeout of the prometheus query
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:307:1
[INFO] [stderr]     |
[INFO] [stderr] 307 | /// A simple Error type to understand different errors.
[INFO] [stderr]     | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:325:1
[INFO] [stderr]     |
[INFO] [stderr] 325 | / /// Represents a prometheus data source that works over an http(s) host:port endpoint potentially
[INFO] [stderr] 326 | | /// behind a /prometheus_prefix/
[INFO] [stderr]     | |________________________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:347:1
[INFO] [stderr]     |
[INFO] [stderr] 347 | /// A Builder struct to create the [`DataSource`]
[INFO] [stderr]     | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:370:1
[INFO] [stderr]     |
[INFO] [stderr] 370 | / impl DataSourceBuilder {
[INFO] [stderr] 371 | |     /// Initializes the builder for the DataSource, required param is the authority, may contain
[INFO] [stderr] 372 | |     /// `user:password@host:port`, or `host:port`
[INFO] [stderr] 373 | |     pub fn new(authority: &str) -> Self {
[INFO] [stderr] ...   |
[INFO] [stderr] 429 | |     }
[INFO] [stderr] 430 | | }
[INFO] [stderr]     | |_^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:371:5
[INFO] [stderr]     |
[INFO] [stderr] 371 | /     /// Initializes the builder for the DataSource, required param is the authority, may contain
[INFO] [stderr] 372 | |     /// `user:password@host:port`, or `host:port`
[INFO] [stderr]     | |_________________________________________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:383:5
[INFO] [stderr]     |
[INFO] [stderr] 383 | /     /// Sets the prefix that hosts prometheus, useful when prometheus is behind a shared reverse
[INFO] [stderr] 384 | |     /// proxy
[INFO] [stderr]     | |_____________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:390:5
[INFO] [stderr]     |
[INFO] [stderr] 390 |     /// Sets the prometheus query param.
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:396:5
[INFO] [stderr]     |
[INFO] [stderr] 396 |     /// Sets the URL scheme, be it http or https
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:402:5
[INFO] [stderr]     |
[INFO] [stderr] 402 |     /// Builds into DataSource after checking and merging fields
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:432:1
[INFO] [stderr]     |
[INFO] [stderr] 432 | / impl DataSource {
[INFO] [stderr] 433 | |     /// `get` is an async operation that returns potentially a Response
[INFO] [stderr] 434 | |     pub async fn get(&self) -> Result<Response, DataSourceError> {
[INFO] [stderr] 435 | |         let url = http::uri::Builder::new()
[INFO] [stderr] ...   |
[INFO] [stderr] 465 | |     }
[INFO] [stderr] 466 | | }
[INFO] [stderr]     | |_^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:433:5
[INFO] [stderr]     |
[INFO] [stderr] 433 |     /// `get` is an async operation that returns potentially a Response
[INFO] [stderr]     |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: `prometheus-http-api` (lib doc) generated 26 warnings
[INFO] [stderr]     Finished dev [unoptimized + debuginfo] target(s) in 1.19s
[INFO] running `Command { std: "docker" "inspect" "5000965c17b288a17a0290608a3bad638ab4f788137712388b867cf8978cac34", kill_on_drop: false }`
[INFO] running `Command { std: "docker" "rm" "-f" "5000965c17b288a17a0290608a3bad638ab4f788137712388b867cf8978cac34", kill_on_drop: false }`
[INFO] [stdout] 5000965c17b288a17a0290608a3bad638ab4f788137712388b867cf8978cac34