pearl 0.9.0

Pearl is a low level blob-based I/O library
Documentation
Build #475150 2021-12-09T13:50:11.698907+00:00
# rustc version
rustc 1.59.0-nightly (e6b883c74 2021-12-08)
# docs.rs version
docsrs 0.6.0 (0607ed2 2021-12-01)

# build log
[INFO] running `Command { std: "docker" "create" "-v" "/home/cratesfyi/workspace/builds/pearl-0.9.0/target:/opt/rustwide/target:rw,Z" "-v" "/home/cratesfyi/workspace/builds/pearl-0.9.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:5df6ddad4a5b29fe213f677d7e2acfdb848e97b967f7cba3bf1fba1640344a16" "/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\", \"-20211208-1.59.0-nightly-e6b883c74\", \"--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] de1f8b24a76805a3238f0de4c1231d34445c7a301c67e1f39230ace53f09741a
[INFO] running `Command { std: "docker" "start" "-a" "de1f8b24a76805a3238f0de4c1231d34445c7a301c67e1f39230ace53f09741a", kill_on_drop: false }`
[INFO] [stderr]  Documenting pearl v0.9.0 (/opt/rustwide/workdir)
[INFO] [stderr] warning: unresolved link to `Future`
[INFO] [stderr]  --> src/blob/entry.rs:3:22
[INFO] [stderr]   |
[INFO] [stderr] 3 | /// [`Entry`] is a [`Future`], which contains header and metadata of the record,
[INFO] [stderr]   |                      ^^^^^^ no item named `Future` in scope
[INFO] [stderr]   |
[INFO] [stderr]   = note: `#[warn(rustdoc::broken_intra_doc_links)]` on by default
[INFO] [stderr]   = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `Optional`
[INFO] [stderr]    --> src/storage/builder.rs:167:10
[INFO] [stderr]     |
[INFO] [stderr] 167 |     /// [Optional]
[INFO] [stderr]     |          ^^^^^^^^ no item named `Optional` in scope
[INFO] [stderr]     |
[INFO] [stderr]     = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `create_active_blob_in_background`
[INFO] [stderr]    --> src/storage/core.rs:161:30
[INFO] [stderr]     |
[INFO] [stderr] 161 |     /// asyncronously, use [`create_active_blob_in_background()`]
[INFO] [stderr]     |                              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `create_active_blob_in_background` in scope
[INFO] [stderr]     |
[INFO] [stderr]     = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `create_active_blob_in_background`
[INFO] [stderr]    --> src/storage/core.rs:165:11
[INFO] [stderr]     |
[INFO] [stderr] 165 |     /// [`create_active_blob_in_background()`]: struct.Storage.html#method.create_active_blob_async
[INFO] [stderr]     |           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `create_active_blob_in_background` in scope
[INFO] [stderr]     |
[INFO] [stderr]     = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `try_create_active_blob`
[INFO] [stderr]    --> src/storage/core.rs:172:54
[INFO] [stderr]     |
[INFO] [stderr] 172 |     /// want be sure about operation's result, use [`try_create_active_blob()`]
[INFO] [stderr]     |                                                      ^^^^^^^^^^^^^^^^^^^^^^^^ no item named `try_create_active_blob` in scope
[INFO] [stderr]     |
[INFO] [stderr]     = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `try_create_active_blob`
[INFO] [stderr]    --> src/storage/core.rs:173:11
[INFO] [stderr]     |
[INFO] [stderr] 173 |     /// [`try_create_active_blob()`]: struct.Storage.html#method.try_create_active_blob
[INFO] [stderr]     |           ^^^^^^^^^^^^^^^^^^^^^^^^ no item named `try_create_active_blob` in scope
[INFO] [stderr]     |
[INFO] [stderr]     = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `close_active_blob_in_background`
[INFO] [stderr]    --> src/storage/core.rs:180:30
[INFO] [stderr]     |
[INFO] [stderr] 180 |     /// asyncronously, use [`close_active_blob_in_background()`]
[INFO] [stderr]     |                              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `close_active_blob_in_background` in scope
[INFO] [stderr]     |
[INFO] [stderr]     = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `close_active_blob_in_background`
[INFO] [stderr]    --> src/storage/core.rs:184:11
[INFO] [stderr]     |
[INFO] [stderr] 184 |     /// [`close_active_blob_in_background()`]: struct.Storage.html#method.create_active_blob_async
[INFO] [stderr]     |           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `close_active_blob_in_background` in scope
[INFO] [stderr]     |
[INFO] [stderr]     = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `try_close_active_blob`
[INFO] [stderr]    --> src/storage/core.rs:193:54
[INFO] [stderr]     |
[INFO] [stderr] 193 |     /// want be sure about operation's result, use [`try_close_active_blob()`]
[INFO] [stderr]     |                                                      ^^^^^^^^^^^^^^^^^^^^^^^ no item named `try_close_active_blob` in scope
[INFO] [stderr]     |
[INFO] [stderr]     = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `restore_active_blob_in_background`
[INFO] [stderr]    --> src/storage/core.rs:201:30
[INFO] [stderr]     |
[INFO] [stderr] 201 |     /// asyncronously, use [`restore_active_blob_in_background()`]
[INFO] [stderr]     |                              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `restore_active_blob_in_background` in scope
[INFO] [stderr]     |
[INFO] [stderr]     = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `restore_active_blob_in_background`
[INFO] [stderr]    --> src/storage/core.rs:205:11
[INFO] [stderr]     |
[INFO] [stderr] 205 |     /// [`restore_active_blob_in_background()`]: struct.Storage.html#method.restore_active_blob_async
[INFO] [stderr]     |           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `restore_active_blob_in_background` in scope
[INFO] [stderr]     |
[INFO] [stderr]     = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `try_restore_active_blob`
[INFO] [stderr]    --> src/storage/core.rs:212:54
[INFO] [stderr]     |
[INFO] [stderr] 212 |     /// want be sure about operation's result, use [`try_restore_active_blob()`]
[INFO] [stderr]     |                                                      ^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `try_restore_active_blob` in scope
[INFO] [stderr]     |
[INFO] [stderr]     = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `try_restore_active_blob`
[INFO] [stderr]    --> src/storage/core.rs:213:11
[INFO] [stderr]     |
[INFO] [stderr] 213 |     /// [`try_restore_active_blob()`]: struct.Storage.html#method.try_restore_active_blob
[INFO] [stderr]     |           ^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `try_restore_active_blob` in scope
[INFO] [stderr]     |
[INFO] [stderr]     = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `close_active_blob_in_background`
[INFO] [stderr]    --> src/storage/core.rs:789:56
[INFO] [stderr]     |
[INFO] [stderr] 789 |     /// This function was used previously instead of [`close_active_blob_in_background()`]
[INFO] [stderr]     |                                                        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `close_active_blob_in_background` in scope
[INFO] [stderr]     |
[INFO] [stderr]     = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `close_active_blob_in_background`
[INFO] [stderr]    --> src/storage/core.rs:794:11
[INFO] [stderr]     |
[INFO] [stderr] 794 |     /// [`close_active_blob_in_background()`]: struct.Storage.html#method.close_active_blob_async
[INFO] [stderr]     |           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `close_active_blob_in_background` in scope
[INFO] [stderr]     |
[INFO] [stderr]     = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
[INFO] [stderr] 
[INFO] [stderr] warning: unknown attribute `no-run`. Did you mean `no_run`?
[INFO] [stderr]   --> src/lib.rs:8:1
[INFO] [stderr]    |
[INFO] [stderr] 8  | / //! # pearl
[INFO] [stderr] 9  | | //!
[INFO] [stderr] 10 | | //! The `pearl` library is an asyncronous Append only key-value blob storage on disk.
[INFO] [stderr] 11 | | //! Crate `pearl` provides [`Futures 0.3`] interface. Tokio runtime required.
[INFO] [stderr] ...  |
[INFO] [stderr] 49 | | //! }
[INFO] [stderr] 50 | | //! ```
[INFO] [stderr]    | |_______^
[INFO] [stderr]    |
[INFO] [stderr]    = note: `#[warn(rustdoc::invalid_codeblock_attributes)]` on by default
[INFO] [stderr]    = help: the code block will either not be tested if not marked as a rust one or will be run (which you might not want)
[INFO] [stderr] 
[INFO] [stderr] warning: unknown attribute `no-run`. Did you mean `no_run`?
[INFO] [stderr]   --> src/storage/builder.rs:3:1
[INFO] [stderr]    |
[INFO] [stderr] 3  | / /// Is used to initialize a `Storage`.
[INFO] [stderr] 4  | | ///
[INFO] [stderr] 5  | | /// Required params:
[INFO] [stderr] 6  | | ///  - [`work_dir`] - where `Storage` will keep blob and index files
[INFO] [stderr] ...  |
[INFO] [stderr] 30 | | /// [`blob_file_name_prefix`]: struct.Builder.html#method.blob_file_name_prefix
[INFO] [stderr] 31 | | /// [`key_size`]: struct.Builder.html#method.key_size
[INFO] [stderr]    | |_____________________________________________________^
[INFO] [stderr]    |
[INFO] [stderr]    = help: the code block will either not be tested if not marked as a rust one or will be run (which you might not want)
[INFO] [stderr] 
[INFO] [stderr] warning: unknown attribute `no-run`. Did you mean `no_run`?
[INFO] [stderr]   --> src/storage/core.rs:9:1
[INFO] [stderr]    |
[INFO] [stderr] 9  | / /// A main storage struct.
[INFO] [stderr] 10 | | ///
[INFO] [stderr] 11 | | /// This type is clonable, cloning it will only create a new reference,
[INFO] [stderr] 12 | | /// not a new storage.
[INFO] [stderr] ...  |
[INFO] [stderr] 33 | | ///
[INFO] [stderr] 34 | | /// [`Key`]: trait.Key.html
[INFO] [stderr]    | |___________________________^
[INFO] [stderr]    |
[INFO] [stderr]    = help: the code block will either not be tested if not marked as a rust one or will be run (which you might not want)
[INFO] [stderr] 
[INFO] [stderr] warning: unknown attribute `no-run`. Did you mean `no_run`?
[INFO] [stderr]    --> src/storage/core.rs:218:5
[INFO] [stderr]     |
[INFO] [stderr] 218 | /     /// Writes `data` to active blob asyncronously. If active blob reaches it limit, creates new
[INFO] [stderr] 219 | |     /// and closes old.
[INFO] [stderr] 220 | |     /// NOTICE! First write into storage without active blob may take more time due to active blob
[INFO] [stderr] 221 | |     /// creation
[INFO] [stderr] ...   |
[INFO] [stderr] 232 | |     ///
[INFO] [stderr] 233 | |     /// [`write_with`]: Storage::write_with
[INFO] [stderr]     | |___________________________________________^
[INFO] [stderr]     |
[INFO] [stderr]     = help: the code block will either not be tested if not marked as a rust one or will be run (which you might not want)
[INFO] [stderr] 
[INFO] [stderr] warning: unknown attribute `no-run`. Did you mean `no_run`?
[INFO] [stderr]    --> src/storage/core.rs:238:5
[INFO] [stderr]     |
[INFO] [stderr] 238 | /     /// Similar to [`write`] but with metadata
[INFO] [stderr] 239 | |     /// # Examples
[INFO] [stderr] 240 | |     /// ```no-run
[INFO] [stderr] 241 | |     /// async fn write_data() {
[INFO] [stderr] ...   |
[INFO] [stderr] 249 | |     /// # Errors
[INFO] [stderr] 250 | |     /// Fails if duplicates are not allowed and record already exists.
[INFO] [stderr]     | |______________________________________________________________________^
[INFO] [stderr]     |
[INFO] [stderr]     = help: the code block will either not be tested if not marked as a rust one or will be run (which you might not want)
[INFO] [stderr] 
[INFO] [stderr] warning: unknown attribute `no-run`. Did you mean `no_run`?
[INFO] [stderr]    --> src/storage/core.rs:296:5
[INFO] [stderr]     |
[INFO] [stderr] 296 | /     /// Reads the first found data matching given key.
[INFO] [stderr] 297 | |     /// # Examples
[INFO] [stderr] 298 | |     /// ```no-run
[INFO] [stderr] 299 | |     /// async fn read_data() {
[INFO] [stderr] ...   |
[INFO] [stderr] 307 | |     /// [`Error::RecordNotFound`]: enum.Error.html#RecordNotFound
[INFO] [stderr] 308 | |     /// [`read_with`]: Storage::read_with
[INFO] [stderr]     | |_________________________________________^
[INFO] [stderr]     |
[INFO] [stderr]     = help: the code block will either not be tested if not marked as a rust one or will be run (which you might not want)
[INFO] [stderr] 
[INFO] [stderr] warning: unknown attribute `no-run`. Did you mean `no_run`?
[INFO] [stderr]    --> src/storage/core.rs:315:5
[INFO] [stderr]     |
[INFO] [stderr] 315 | /     /// Reads data matching given key and metadata
[INFO] [stderr] 316 | |     /// # Examples
[INFO] [stderr] 317 | |     /// ```no-run
[INFO] [stderr] 318 | |     /// async fn read_data() {
[INFO] [stderr] ...   |
[INFO] [stderr] 327 | |     ///
[INFO] [stderr] 328 | |     /// [`Error::RecordNotFound`]: enum.Error.html#RecordNotFound
[INFO] [stderr]     | |_________________________________________________________________^
[INFO] [stderr]     |
[INFO] [stderr]     = help: the code block will either not be tested if not marked as a rust one or will be run (which you might not want)
[INFO] [stderr] 
[INFO] [stderr] warning: unknown attribute `no-run`. Did you mean `no_run`?
[INFO] [stderr]    --> src/storage/core.rs:455:5
[INFO] [stderr]     |
[INFO] [stderr] 455 | /     /// `blob_count` returns exact number of closed blobs plus one active, if there is some.
[INFO] [stderr] 456 | |     /// It locks on inner structure, so it much slower than `next_blob_id`.
[INFO] [stderr] 457 | |     /// # Examples
[INFO] [stderr] 458 | |     /// ```no-run
[INFO] [stderr] ...   |
[INFO] [stderr] 463 | |     /// assert_eq!(storage.blobs_count(), 1);
[INFO] [stderr] 464 | |     /// ```
[INFO] [stderr]     | |___________^
[INFO] [stderr]     |
[INFO] [stderr]     = help: the code block will either not be tested if not marked as a rust one or will be run (which you might not want)
[INFO] [stderr] 
[INFO] [stderr] warning: `pearl` (lib doc) generated 23 warnings
[INFO] [stderr]     Finished dev [unoptimized + debuginfo] target(s) in 2.86s
[INFO] running `Command { std: "docker" "inspect" "de1f8b24a76805a3238f0de4c1231d34445c7a301c67e1f39230ace53f09741a", kill_on_drop: false }`
[INFO] running `Command { std: "docker" "rm" "-f" "de1f8b24a76805a3238f0de4c1231d34445c7a301c67e1f39230ace53f09741a", kill_on_drop: false }`
[INFO] [stdout] de1f8b24a76805a3238f0de4c1231d34445c7a301c67e1f39230ace53f09741a