flashmap 0.0.1-alpha

A lock-free eventually consistent concurrent hash map.
Documentation

Build #586541 2022-07-03 03:35:09

# rustc version rustc 1.64.0-nightly (f2d93935f 2022-07-02)

# docs.rs version docsrs 0.6.0 (1ce3fd8 2022-06-22)

# build log [INFO] running `Command { std: "docker" "create" "-v" "/home/cratesfyi/workspace/builds/flashmap-0.0.1-alpha/target:/opt/rustwide/target:rw,Z" "-v" "/home/cratesfyi/workspace/builds/flashmap-0.0.1-alpha/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:ac0d0aa6ec8ed129e241004a6179c99fa0d2616f50ba759c5b60bd26d0fafa02" "/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\", \"-20220702-1.64.0-nightly-f2d93935f\", \"--static-root-path\", \"/\", \"--cap-lints\", \"warn\", \"--disable-per-crate-search\", \"--extern-html-root-takes-precedence\"]" "-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] 05381602eb67d675592120358614997f7cd6a3579ecdb5792cc1d017a2c34d42 [INFO] running `Command { std: "docker" "start" "-a" "05381602eb67d675592120358614997f7cd6a3579ecdb5792cc1d017a2c34d42", kill_on_drop: false }` [INFO] [stderr] Documenting flashmap v0.0.1-alpha (/opt/rustwide/workdir) [INFO] [stderr] warning: missing documentation for a struct [INFO] [stderr] --> src/read.rs:17:1 [INFO] [stderr] | [INFO] [stderr] 17 | pub struct ReadHandle<K, V, S = RandomState> { [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(missing_docs, missing_debug_implementations)] [INFO] [stderr] | ^^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for an associated function [INFO] [stderr] --> src/read.rs:42:5 [INFO] [stderr] | [INFO] [stderr] 42 | pub fn guard(&self) -> ReadGuard<'_, K, V, S> { [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for a struct [INFO] [stderr] --> src/read.rs:67:1 [INFO] [stderr] | [INFO] [stderr] 67 | pub struct ReadGuard<'a, K, V, S> { [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for an associated function [INFO] [stderr] --> src/read.rs:75:5 [INFO] [stderr] | [INFO] [stderr] 75 | pub fn len(&self) -> usize { [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for an associated function [INFO] [stderr] --> src/read.rs:80:5 [INFO] [stderr] | [INFO] [stderr] 80 | / pub fn contains_key<Q: ?Sized>(&self, key: &Q) -> bool [INFO] [stderr] 81 | | where [INFO] [stderr] 82 | | Alias<K>: Borrow<Q> + Eq + Hash, [INFO] [stderr] 83 | | Q: Hash + Eq, [INFO] [stderr] 84 | | { [INFO] [stderr] 85 | | self.map.with(|ptr| unsafe { &*ptr }.contains_key(key)) [INFO] [stderr] 86 | | } [INFO] [stderr] | |_____^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for an associated function [INFO] [stderr] --> src/read.rs:89:5 [INFO] [stderr] | [INFO] [stderr] 89 | / pub fn get<Q: ?Sized>(&self, key: &Q) -> Option<&V> [INFO] [stderr] 90 | | where [INFO] [stderr] 91 | | Alias<K>: Borrow<Q> + Eq + Hash, [INFO] [stderr] 92 | | Q: Hash + Eq, [INFO] [stderr] ... | [INFO] [stderr] 95 | | .with(|ptr| unsafe { &*ptr }.get(key).map(|value| &**value)) [INFO] [stderr] 96 | | } [INFO] [stderr] | |_____^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for an associated function [INFO] [stderr] --> src/read.rs:99:5 [INFO] [stderr] | [INFO] [stderr] 99 | pub fn iter(&self) -> impl Iterator<Item = (&K, &V)> { [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for an associated function [INFO] [stderr] --> src/read.rs:108:5 [INFO] [stderr] | [INFO] [stderr] 108 | pub fn keys(&self) -> impl Iterator<Item = &K> { [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for an associated function [INFO] [stderr] --> src/read.rs:114:5 [INFO] [stderr] | [INFO] [stderr] 114 | pub fn values(&self) -> impl Iterator<Item = &V> { [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for a struct [INFO] [stderr] --> src/write.rs:10:1 [INFO] [stderr] | [INFO] [stderr] 10 | / pub struct WriteHandle<K, V, S = RandomState> [INFO] [stderr] 11 | | where [INFO] [stderr] 12 | | K: Hash + Eq, [INFO] [stderr] 13 | | S: BuildHasher, [INFO] [stderr] ... | [INFO] [stderr] 16 | | operations: Vec<Operation<K, V>>, [INFO] [stderr] 17 | | } [INFO] [stderr] | |_^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for an associated function [INFO] [stderr] --> src/write.rs:40:5 [INFO] [stderr] | [INFO] [stderr] 40 | pub fn guard(&mut self) -> WriteGuard<'_, K, V, S> { [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for a struct [INFO] [stderr] --> src/write.rs:97:1 [INFO] [stderr] | [INFO] [stderr] 97 | / pub struct WriteGuard<'a, K, V, S> [INFO] [stderr] 98 | | where [INFO] [stderr] 99 | | K: Hash + Eq, [INFO] [stderr] 100 | | S: BuildHasher, [INFO] [stderr] ... | [INFO] [stderr] 103 | | map: &'a UnsafeCell<Map<K, V, S>>, [INFO] [stderr] 104 | | } [INFO] [stderr] | |_^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for an associated function [INFO] [stderr] --> src/write.rs:112:5 [INFO] [stderr] | [INFO] [stderr] 112 | pub fn insert(&mut self, key: K, value: V) -> InsertionResult { [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for an associated function [INFO] [stderr] --> src/write.rs:134:5 [INFO] [stderr] | [INFO] [stderr] 134 | / pub fn rcu<F>(&mut self, key: K, rcu: F) -> bool [INFO] [stderr] 135 | | where [INFO] [stderr] 136 | | F: FnOnce(&V) -> V, [INFO] [stderr] 137 | | { [INFO] [stderr] ... | [INFO] [stderr] 149 | | }) [INFO] [stderr] 150 | | } [INFO] [stderr] | |_____^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for an associated function [INFO] [stderr] --> src/write.rs:153:5 [INFO] [stderr] | [INFO] [stderr] 153 | pub fn remove(&mut self, key: K) -> RemovalResult { [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for an enum [INFO] [stderr] --> src/write.rs:185:1 [INFO] [stderr] | [INFO] [stderr] 185 | pub enum InsertionResult { [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for a variant [INFO] [stderr] --> src/write.rs:186:5 [INFO] [stderr] | [INFO] [stderr] 186 | Inserted, [INFO] [stderr] | ^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for a variant [INFO] [stderr] --> src/write.rs:187:5 [INFO] [stderr] | [INFO] [stderr] 187 | ReplacedOccupier, [INFO] [stderr] | ^^^^^^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for an enum [INFO] [stderr] --> src/write.rs:191:1 [INFO] [stderr] | [INFO] [stderr] 191 | pub enum RemovalResult { [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for a variant [INFO] [stderr] --> src/write.rs:192:5 [INFO] [stderr] | [INFO] [stderr] 192 | Removed, [INFO] [stderr] | ^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for a variant [INFO] [stderr] --> src/write.rs:193:5 [INFO] [stderr] | [INFO] [stderr] 193 | NotFound, [INFO] [stderr] | ^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for a function [INFO] [stderr] --> src/lib.rs:23:1 [INFO] [stderr] | [INFO] [stderr] 23 | / pub fn new<K, V>() -> (WriteHandle<K, V>, ReadHandle<K, V>) [INFO] [stderr] 24 | | where [INFO] [stderr] 25 | | K: Eq + Hash, [INFO] [stderr] 26 | | { [INFO] [stderr] 27 | | Builder::new().build() [INFO] [stderr] 28 | | } [INFO] [stderr] | |_^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for a function [INFO] [stderr] --> src/lib.rs:30:1 [INFO] [stderr] | [INFO] [stderr] 30 | / pub fn with_capacity<K, V>(capacity: usize) -> (WriteHandle<K, V>, ReadHandle<K, V>) [INFO] [stderr] 31 | | where [INFO] [stderr] 32 | | K: Eq + Hash, [INFO] [stderr] 33 | | { [INFO] [stderr] 34 | | Builder::new().with_capacity(capacity).build() [INFO] [stderr] 35 | | } [INFO] [stderr] | |_^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for a function [INFO] [stderr] --> src/lib.rs:37:1 [INFO] [stderr] | [INFO] [stderr] 37 | / pub fn with_hasher<K, V, S>(hasher: S) -> (WriteHandle<K, V, S>, ReadHandle<K, V, S>) [INFO] [stderr] 38 | | where [INFO] [stderr] 39 | | K: Eq + Hash, [INFO] [stderr] 40 | | S: Clone + BuildHasher, [INFO] [stderr] 41 | | { [INFO] [stderr] 42 | | Builder::new().with_hasher(hasher).build() [INFO] [stderr] 43 | | } [INFO] [stderr] | |_^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for a struct [INFO] [stderr] --> src/lib.rs:46:1 [INFO] [stderr] | [INFO] [stderr] 46 | pub struct Builder<S = RandomState> { [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for an associated function [INFO] [stderr] --> src/lib.rs:61:5 [INFO] [stderr] | [INFO] [stderr] 61 | pub fn new() -> Self { [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for an associated function [INFO] [stderr] --> src/lib.rs:73:5 [INFO] [stderr] | [INFO] [stderr] 73 | pub fn with_capacity(self, capacity: usize) -> Self { [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for an associated function [INFO] [stderr] --> src/lib.rs:80:5 [INFO] [stderr] | [INFO] [stderr] 80 | / pub fn with_hasher<H>(self, hasher: H) -> Builder<H> [INFO] [stderr] 81 | | where [INFO] [stderr] 82 | | H: Clone + BuildHasher, [INFO] [stderr] 83 | | { [INFO] [stderr] ... | [INFO] [stderr] 87 | | } [INFO] [stderr] 88 | | } [INFO] [stderr] | |_____^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for an associated function [INFO] [stderr] --> src/lib.rs:90:5 [INFO] [stderr] | [INFO] [stderr] 90 | / pub fn with_hasher_fn<H>(self, make: fn() -> H) -> Builder<H> [INFO] [stderr] 91 | | where [INFO] [stderr] 92 | | H: BuildHasher, [INFO] [stderr] 93 | | { [INFO] [stderr] ... | [INFO] [stderr] 97 | | } [INFO] [stderr] 98 | | } [INFO] [stderr] | |_____^ [INFO] [stderr] [INFO] [stderr] warning: missing documentation for an associated function [INFO] [stderr] --> src/lib.rs:100:5 [INFO] [stderr] | [INFO] [stderr] 100 | / pub fn build<K, V>(self) -> (WriteHandle<K, V, S>, ReadHandle<K, V, S>) [INFO] [stderr] 101 | | where [INFO] [stderr] 102 | | K: Eq + Hash, [INFO] [stderr] 103 | | S: BuildHasher, [INFO] [stderr] 104 | | { [INFO] [stderr] 105 | | core::Handle::new(self) [INFO] [stderr] 106 | | } [INFO] [stderr] | |_____^ [INFO] [stderr] [INFO] [stderr] warning: `flashmap` (lib doc) generated 30 warnings [INFO] [stderr] Finished dev [unoptimized + debuginfo] target(s) in 0.83s [INFO] running `Command { std: "docker" "inspect" "05381602eb67d675592120358614997f7cd6a3579ecdb5792cc1d017a2c34d42", kill_on_drop: false }` [INFO] running `Command { std: "docker" "rm" "-f" "05381602eb67d675592120358614997f7cd6a3579ecdb5792cc1d017a2c34d42", kill_on_drop: false }` [INFO] [stdout] 05381602eb67d675592120358614997f7cd6a3579ecdb5792cc1d017a2c34d42