bpaf 0.3.0

A simple proc macro free Command Line Argument Parser
Documentation
Build #526575 2022-03-16T06:38:48.498848+00:00
# rustc version
rustc 1.61.0-nightly (52b34550a 2022-03-15)# docs.rs version
docsrs 0.6.0 (5188c7e 2022-03-04)# build log
[INFO] running `Command { std: "docker" "create" "-v" "/home/cratesfyi/workspace/builds/bpaf-0.3.0/target:/opt/rustwide/target:rw,Z" "-v" "/home/cratesfyi/workspace/builds/bpaf-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:1ede1414886370302e694df474b9877c02906499f04c196936ce0973d30c5eaa" "/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\", \"-20220315-1.61.0-nightly-52b34550a\", \"--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] [stderr] WARNING: Your kernel does not support swap limit capabilities or the cgroup is not mounted. Memory limited without swap.
[INFO] [stdout] eddf138622028a11383ea76ecd96721621b4bfb2d5a0b50091a77ec0d05bc820
[INFO] running `Command { std: "docker" "start" "-a" "eddf138622028a11383ea76ecd96721621b4bfb2d5a0b50091a77ec0d05bc820", kill_on_drop: false }`
[INFO] [stderr]  Documenting bpaf v0.3.0 (/opt/rustwide/workdir)
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]   --> src/params.rs:1:1
[INFO] [stderr]    |
[INFO] [stderr] 1  | / //! Primitives to define parsers
[INFO] [stderr] 2  | | //!
[INFO] [stderr] 3  | | //! # Terminology
[INFO] [stderr] 4  | | //!
[INFO] [stderr] ...  |
[INFO] [stderr] 53 | | //! ```
[INFO] [stderr] 54 | | //!
[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  | #![warn(rustdoc::missing_doc_code_examples)]
[INFO] [stderr]    |         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]   --> src/params.rs:63:1
[INFO] [stderr]    |
[INFO] [stderr] 63 | /// A named thing used to create Flag, Switch or Argument.
[INFO] [stderr]    | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/params.rs:119:1
[INFO] [stderr]     |
[INFO] [stderr] 119 | / impl Named {
[INFO] [stderr] 120 | |     /// Add a short name to a flag/switch/argument
[INFO] [stderr] 121 | |     ///
[INFO] [stderr] 122 | |     /// You can specify it multiple times, items past the first one represent
[INFO] [stderr] ...   |
[INFO] [stderr] 290 | |     }
[INFO] [stderr] 291 | | }
[INFO] [stderr]     | |_^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:119:1
[INFO] [stderr]     |
[INFO] [stderr] 119 | /// Simple or composed argument parser
[INFO] [stderr]     | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:130:1
[INFO] [stderr]     |
[INFO] [stderr] 130 | / impl<T> Parser<T> {
[INFO] [stderr] 131 | |     /// Wrap a value into a `Parser`
[INFO] [stderr] 132 | |     ///
[INFO] [stderr] 133 | |     /// Parser will produce `T` without consuming anything from the command line, can be useful
[INFO] [stderr] ...   |
[INFO] [stderr] 493 | |     }
[INFO] [stderr] 494 | | }
[INFO] [stderr]     | |_^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:496:1
[INFO] [stderr]     |
[INFO] [stderr] 496 | / impl Parser<String> {
[INFO] [stderr] 497 | |     /// Parse stored [`String`] using [`FromStr`] instance
[INFO] [stderr] 498 | |     ///
[INFO] [stderr] 499 | |     /// ```rust
[INFO] [stderr] ...   |
[INFO] [stderr] 513 | |     }
[INFO] [stderr] 514 | | }
[INFO] [stderr]     | |_^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:516:1
[INFO] [stderr]     |
[INFO] [stderr] 516 | / /// Unsuccessful command line parsing outcome
[INFO] [stderr] 517 | | ///
[INFO] [stderr] 518 | | /// Useful for unit testing for user parsers, intented to
[INFO] [stderr] 519 | | /// be consumed with [`ParseFailure::unwrap_stdout`] and [`ParseFailure::unwrap_stdout`]
[INFO] [stderr]     | |________________________________________________________________________________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:528:1
[INFO] [stderr]     |
[INFO] [stderr] 528 | / impl ParseFailure {
[INFO] [stderr] 529 | |     /// Returns the contained `stderr` values
[INFO] [stderr] 530 | |     ///
[INFO] [stderr] 531 | |     /// Intended to be used with unit tests
[INFO] [stderr] ...   |
[INFO] [stderr] 561 | |     }
[INFO] [stderr] 562 | | }
[INFO] [stderr]     | |_^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:529:5
[INFO] [stderr]     |
[INFO] [stderr] 529 | /     /// Returns the contained `stderr` values
[INFO] [stderr] 530 | |     ///
[INFO] [stderr] 531 | |     /// Intended to be used with unit tests
[INFO] [stderr] 532 | |     ///
[INFO] [stderr] 533 | |     /// # Panics
[INFO] [stderr] 534 | |     ///
[INFO] [stderr] 535 | |     /// Will panic if failure contains `stdout`
[INFO] [stderr]     | |_______________________________________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:546:5
[INFO] [stderr]     |
[INFO] [stderr] 546 | /     /// Returns the contained `stdout` values
[INFO] [stderr] 547 | |     ///
[INFO] [stderr] 548 | |     /// Intended to be used with unit tests
[INFO] [stderr] 549 | |     ///
[INFO] [stderr] 550 | |     /// # Panics
[INFO] [stderr] 551 | |     ///
[INFO] [stderr] 552 | |     /// Will panic if failure contains `stderr`
[INFO] [stderr]     | |_______________________________________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]    --> src/lib.rs:564:1
[INFO] [stderr]     |
[INFO] [stderr] 564 | / impl<T> OptionParser<T> {
[INFO] [stderr] 565 | |     /// Execute the [`OptionParser`], extract a parsed value or print some diagnostic and exit
[INFO] [stderr] 566 | |     ///
[INFO] [stderr] 567 | |     /// ```no_run
[INFO] [stderr] ...   |
[INFO] [stderr] 651 | |     }
[INFO] [stderr] 652 | | }
[INFO] [stderr]     | |_^
[INFO] [stderr] 
[INFO] [stderr] warning: `bpaf` (lib doc) generated 11 warnings
[INFO] [stderr]     Finished dev [unoptimized + debuginfo] target(s) in 0.87s
[INFO] running `Command { std: "docker" "inspect" "eddf138622028a11383ea76ecd96721621b4bfb2d5a0b50091a77ec0d05bc820", kill_on_drop: false }`
[INFO] running `Command { std: "docker" "rm" "-f" "eddf138622028a11383ea76ecd96721621b4bfb2d5a0b50091a77ec0d05bc820", kill_on_drop: false }`
[INFO] [stdout] eddf138622028a11383ea76ecd96721621b4bfb2d5a0b50091a77ec0d05bc820