raindb 1.0.0

A persistent key-value store based on an LSM tree implemented in Rust
Documentation
Build #690258 2022-12-02 08:18:24

# rustc version rustc 1.67.0-nightly (c090c6880 2022-12-01)

# docs.rs version docsrs 0.6.0 (a46af5d2 2022-12-02)

# build log [INFO] running `Command { std: "docker" "create" "-v" "/home/cratesfyi/workspace/builds/raindb-1.0.0/target:/opt/rustwide/target:rw,Z" "-v" "/home/cratesfyi/workspace/builds/raindb-1.0.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:bb5b0feb4f87116a4ea905b7ff5bf5b85913db05e9f0fbc1abdd3168928d9075" "/opt/rustwide/cargo-home/bin/cargo" "+nightly" "rustdoc" "--lib" "-Zrustdoc-map" "-Z" "unstable-options" "--config" "build.rustdocflags=[\"--document-private-items\", \"-Z\", \"unstable-options\", \"--emit=invocation-specific\", \"--resource-suffix\", \"-20221201-1.67.0-nightly-c090c6880\", \"--static-root-path\", \"/-/rustdoc.static/\", \"--cap-lints\", \"warn\", \"--disable-per-crate-search\", \"--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\"" "-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] 9fa64c09cb0aefe213987d6079723673c5d2751df0c87b1e6d60a76b0f405b6e [INFO] running `Command { std: "docker" "start" "-a" "9fa64c09cb0aefe213987d6079723673c5d2751df0c87b1e6d60a76b0f405b6e", kill_on_drop: false }` [INFO] [stderr] Documenting raindb v1.0.0 (/opt/rustwide/workdir) [INFO] [stderr] warning: public documentation for `apply` links to private item `DB::apply_changes` [INFO] [stderr] --> src/db.rs:499:48 [INFO] [stderr] | [INFO] [stderr] 499 | This is the public API to the underlying [`DB::apply_changes`] method. [INFO] [stderr] | ^^^^^^^^^^^^^^^^^ this item is private [INFO] [stderr] | [INFO] [stderr] = note: this link resolves only because you passed `--document-private-items`, but will break without [INFO] [stderr] = note: `#[warn(rustdoc::private_intra_doc_links)]` on by default [INFO] [stderr] [INFO] [stderr] warning: unresolved link to `CompactionManifest::IsBaseLevelForKey` [INFO] [stderr] --> src/compaction/manifest.rs:89:7 [INFO] [stderr] | [INFO] [stderr] 89 | [`CompactionManifest::IsBaseLevelForKey`] method. [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ the struct `CompactionManifest` has no field or associated item named `IsBaseLevelForKey` [INFO] [stderr] | [INFO] [stderr] = note: `#[warn(rustdoc::broken_intra_doc_links)]` on by default [INFO] [stderr] [INFO] [stderr] warning: unresolved link to `DB::tables_in_use` [INFO] [stderr] --> src/compaction/worker.rs:829:72 [INFO] [stderr] | [INFO] [stderr] 829 | /// Clean up compaction artifacts that are no longer needed e.g. [`DB::tables_in_use`]. [INFO] [stderr] | ^^^^^^^^^^^^^^^^^ the struct `DB` has no field or associated item named `tables_in_use` [INFO] [stderr] [INFO] [stderr] warning: unresolved link to `crate::block_handle::BLOCK_HANDLE_MAX_ENCODED_LENGTH` [INFO] [stderr] --> src/tables/footer.rs:49:28 [INFO] [stderr] | [INFO] [stderr] 49 | - 40 comes from (2 * [`crate::block_handle::BLOCK_HANDLE_MAX_ENCODED_LENGTH`]) [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `block_handle` in module `raindb` [INFO] [stderr] [INFO] [stderr] warning: unresolved link to `TwoLevelIterator::data_block` [INFO] [stderr] --> src/tables/table.rs:436:62 [INFO] [stderr] | [INFO] [stderr] 436 | /// The block handle used to get the data block in the [`TwoLevelIterator::data_block`] field. [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ the struct `TwoLevelIterator` has no field or associated item named `data_block` [INFO] [stderr] [INFO] [stderr] warning: public documentation for `insert` links to private item `CacheEntry` [INFO] [stderr] --> src/utils/cache.rs:38:17 [INFO] [stderr] | [INFO] [stderr] 38 | Returns a [`CacheEntry`] for the inserted value. [INFO] [stderr] | ^^^^^^^^^^ this item is private [INFO] [stderr] | [INFO] [stderr] = note: this link resolves only because you passed `--document-private-items`, but will break without [INFO] [stderr] [INFO] [stderr] warning: unresolved link to `SeekCompactionMetadata::file_to_compact` [INFO] [stderr] --> src/versioning/version_set.rs:640:58 [INFO] [stderr] | [INFO] [stderr] 640 | 1. A seek based compaction must have a file in the [`SeekCompactionMetadata::file_to_compact`] [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `SeekCompactionMetadata` in scope [INFO] [stderr] [INFO] [stderr] warning: unresolved link to `super::version_set::VersionSetBuilder::save_to_version` [INFO] [stderr] --> src/versioning/version_manifest.rs:109:7 [INFO] [stderr] | [INFO] [stderr] 109 | [`super::version_set::VersionSetBuilder::save_to_version`]. The smallest and largest keys [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `VersionSetBuilder` in module `version_set` [INFO] [stderr] [INFO] [stderr] warning: unresolved link to `Version::GetStats` [INFO] [stderr] --> src/versioning/version.rs:26:24 [INFO] [stderr] | [INFO] [stderr] 26 | This is analogous to [`Version::GetStats`] in LevelDB. The name used in RainDB attempts to be more [INFO] [stderr] | ^^^^^^^^^^^^^^^^^ the struct `Version` has no field or associated item named `GetStats` [INFO] [stderr] [INFO] [stderr] warning: unclosed HTML tag `u8` [INFO] [stderr] --> src/tables/block.rs:160:21 [INFO] [stderr] | [INFO] [stderr] 160 | * key_delta: Vec<u8> where this is a buffer the size of `key_num_unshared_bytes` [INFO] [stderr] | ^^^^ [INFO] [stderr] | [INFO] [stderr] = note: `#[warn(rustdoc::invalid_html_tags)]` on by default [INFO] [stderr] help: try marking as source code [INFO] [stderr] | [INFO] [stderr] 160 | * key_delta: `Vec<u8>` where this is a buffer the size of `key_num_unshared_bytes` [INFO] [stderr] | + + [INFO] [stderr] [INFO] [stderr] warning: unclosed HTML tag `u8` [INFO] [stderr] --> src/tables/block.rs:161:17 [INFO] [stderr] | [INFO] [stderr] 161 | * value: Vec<u8> [INFO] [stderr] | ^^^^ [INFO] [stderr] | [INFO] [stderr] help: try marking as source code [INFO] [stderr] | [INFO] [stderr] 161 | * value: `Vec<u8>` [INFO] [stderr] | + + [INFO] [stderr] [INFO] [stderr] warning: this URL is not a hyperlink [INFO] [stderr] --> src/config.rs:106:35 [INFO] [stderr] | [INFO] [stderr] 106 | TODO: Make allowed_seeks tunable (https://github.com/google/leveldb/issues/229) [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://github.com/google/leveldb/issues/229>` [INFO] [stderr] | [INFO] [stderr] = note: bare URLs are not automatically turned into clickable links [INFO] [stderr] = note: `#[warn(rustdoc::bare_urls)]` on by default [INFO] [stderr] [INFO] [stderr] warning: `raindb` (lib doc) generated 12 warnings (run `cargo fix --lib -p raindb` to apply 1 suggestion) [INFO] [stderr] Finished dev [unoptimized + debuginfo] target(s) in 1.28s [INFO] running `Command { std: "docker" "inspect" "9fa64c09cb0aefe213987d6079723673c5d2751df0c87b1e6d60a76b0f405b6e", kill_on_drop: false }` [INFO] running `Command { std: "docker" "rm" "-f" "9fa64c09cb0aefe213987d6079723673c5d2751df0c87b1e6d60a76b0f405b6e", kill_on_drop: false }` [INFO] [stdout] 9fa64c09cb0aefe213987d6079723673c5d2751df0c87b1e6d60a76b0f405b6e