fd-lock 2.0.0

Advisory cross-platform lock on a file using a file descriptor to it.
Documentation
Build #327466 2020-12-21T17:25:39.451852+00:00
# rustc version
rustc 1.50.0-nightly (c609b2eaf 2020-12-20)# docs.rs version
docsrs 0.6.0 (f9bd68e 2020-12-21)# build log
[INFO] running `Command { std: "docker" "create" "-v" "/home/cratesfyi/workspace/builds/fd-lock-2.0.0/target:/opt/rustwide/target:rw,Z" "-v" "/home/cratesfyi/workspace/builds/fd-lock-2.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" "2" "--user" "1001:1001" "--network" "none" "rustops/crates-build-env@sha256:b8eeb62f26c39b23691079a6cb6de528d8e88b4d71a8f6b1d30f8ba7d9c16de9" "/opt/rustwide/cargo-home/bin/cargo" "+nightly" "rustdoc" "--lib" "-Zrustdoc-map" "-Zunstable-options" "--config=doc.extern-map.registries.crates-io=\"https://docs.rs\"" "-j2" "--" "-Z" "unstable-options" "--resource-suffix" "-20201220-1.50.0-nightly-c609b2eaf" "--static-root-path" "/" "--cap-lints" "warn" "--disable-per-crate-search", kill_on_drop: false }`
[INFO] [stdout] 641cef144c91dce11b512b073c9bfcde576f6a7baecd44f4d3a988214979f62f
[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" "641cef144c91dce11b512b073c9bfcde576f6a7baecd44f4d3a988214979f62f", kill_on_drop: false }`
[INFO] [stderr] /opt/crates-build-env/entrypoint.sh: line 7: /etc/hosts: Permission denied
[INFO] [stderr]    Compiling libc v0.2.81
[INFO] [stderr]  Documenting fd-lock v2.0.0 (/opt/rustwide/workdir)
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]   --> src/unix.rs:1:1
[INFO] [stderr]    |
[INFO] [stderr] 1  | / use libc::{flock, LOCK_EX, LOCK_NB, LOCK_UN};
[INFO] [stderr] 2  | | use std::io::{self, Error, ErrorKind};
[INFO] [stderr] 3  | | use std::ops;
[INFO] [stderr] 4  | | use std::os::unix::io::AsRawFd;
[INFO] [stderr] ...  |
[INFO] [stderr] 95 | |     }
[INFO] [stderr] 96 | | }
[INFO] [stderr]    | |_^
[INFO] [stderr]    |
[INFO] [stderr] note: the lint level is defined here
[INFO] [stderr]   --> src/lib.rs:30:5
[INFO] [stderr]    |
[INFO] [stderr] 30 |     missing_doc_code_examples,
[INFO] [stderr]    |     ^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]   --> src/unix.rs:6:1
[INFO] [stderr]    |
[INFO] [stderr] 6  | / /// A guard that unlocks the file descriptor when it goes out of scope.
[INFO] [stderr] 7  | | ///
[INFO] [stderr] 8  | | /// # Panics
[INFO] [stderr] 9  | | ///
[INFO] [stderr] 10 | | /// Dropping this type may panic if the lock fails to unlock.
[INFO] [stderr]    | |_____________________________________________________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]   --> src/unix.rs:42:1
[INFO] [stderr]    |
[INFO] [stderr] 42 | /// A file descriptor lock.
[INFO] [stderr]    | ^^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]   --> src/unix.rs:48:1
[INFO] [stderr]    |
[INFO] [stderr] 48 | / impl<T: AsRawFd> FdLock<T> {
[INFO] [stderr] 49 | |     /// Create a new instance.
[INFO] [stderr] 50 | |     #[inline]
[INFO] [stderr] 51 | |     pub fn new(t: T) -> Self {
[INFO] [stderr] ...  |
[INFO] [stderr] 95 | |     }
[INFO] [stderr] 96 | | }
[INFO] [stderr]    | |_^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]   --> src/unix.rs:49:5
[INFO] [stderr]    |
[INFO] [stderr] 49 |     /// Create a new instance.
[INFO] [stderr]    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]   --> src/unix.rs:55:5
[INFO] [stderr]    |
[INFO] [stderr] 55 | /     /// Acquires a new lock, blocking the current thread until it's able to do so.
[INFO] [stderr] 56 | |     ///
[INFO] [stderr] 57 | |     /// This function will block the local thread until it is available to acquire the lock. Upon
[INFO] [stderr] 58 | |     /// returning, the thread is the only thread with the lock held. An RAII guard is returned to allow
[INFO] [stderr] ...  |
[INFO] [stderr] 62 | |     ///
[INFO] [stderr] 63 | |     /// On Unix this may return an error if the operation was interrupted by a signal handler.
[INFO] [stderr]    | |______________________________________________________________________________________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]   --> src/unix.rs:73:5
[INFO] [stderr]    |
[INFO] [stderr] 73 | /     /// Attempts to acquire an advisory lock.
[INFO] [stderr] 74 | |     ///
[INFO] [stderr] 75 | |     /// Unlike `FdLock::lock` this function will never block, but instead will
[INFO] [stderr] 76 | |     /// return an error if the lock cannot be acquired.
[INFO] [stderr] ...  |
[INFO] [stderr] 81 | |     /// returned. This may also return an error if the operation was interrupted
[INFO] [stderr] 82 | |     /// by a signal handler.
[INFO] [stderr]    | |____________________________^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]   --> src/unix.rs:32:1
[INFO] [stderr]    |
[INFO] [stderr] 32 | / impl<T: AsRawFd> Drop for FdLockGuard<'_, T> {
[INFO] [stderr] 33 | |     #[inline]
[INFO] [stderr] 34 | |     fn drop(&mut self) {
[INFO] [stderr] 35 | |         let fd = self.lock.t.as_raw_fd();
[INFO] [stderr] ...  |
[INFO] [stderr] 39 | |     }
[INFO] [stderr] 40 | | }
[INFO] [stderr]    | |_^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]   --> src/unix.rs:34:5
[INFO] [stderr]    |
[INFO] [stderr] 34 | /     fn drop(&mut self) {
[INFO] [stderr] 35 | |         let fd = self.lock.t.as_raw_fd();
[INFO] [stderr] 36 | |         if unsafe { flock(fd, LOCK_UN | LOCK_NB) } != 0 {
[INFO] [stderr] 37 | |             panic!("Could not unlock the file descriptor");
[INFO] [stderr] 38 | |         }
[INFO] [stderr] 39 | |     }
[INFO] [stderr]    | |_____^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]   --> src/unix.rs:16:1
[INFO] [stderr]    |
[INFO] [stderr] 16 | / impl<T: AsRawFd> ops::Deref for FdLockGuard<'_, T> {
[INFO] [stderr] 17 | |     type Target = T;
[INFO] [stderr] 18 | |
[INFO] [stderr] 19 | |     #[inline]
[INFO] [stderr] ...  |
[INFO] [stderr] 22 | |     }
[INFO] [stderr] 23 | | }
[INFO] [stderr]    | |_^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]   --> src/unix.rs:20:5
[INFO] [stderr]    |
[INFO] [stderr] 20 | /     fn deref(&self) -> &Self::Target {
[INFO] [stderr] 21 | |         &self.lock.t
[INFO] [stderr] 22 | |     }
[INFO] [stderr]    | |_____^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]   --> src/unix.rs:25:1
[INFO] [stderr]    |
[INFO] [stderr] 25 | / impl<T: AsRawFd> ops::DerefMut for FdLockGuard<'_, T> {
[INFO] [stderr] 26 | |     #[inline]
[INFO] [stderr] 27 | |     fn deref_mut(&mut self) -> &mut Self::Target {
[INFO] [stderr] 28 | |         &mut self.lock.t
[INFO] [stderr] 29 | |     }
[INFO] [stderr] 30 | | }
[INFO] [stderr]    | |_^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]   --> src/unix.rs:27:5
[INFO] [stderr]    |
[INFO] [stderr] 27 | /     fn deref_mut(&mut self) -> &mut Self::Target {
[INFO] [stderr] 28 | |         &mut self.lock.t
[INFO] [stderr] 29 | |     }
[INFO] [stderr]    | |_____^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]   --> src/unix.rs:11:10
[INFO] [stderr]    |
[INFO] [stderr] 11 | #[derive(Debug)]
[INFO] [stderr]    |          ^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: missing code example in this documentation
[INFO] [stderr]   --> src/unix.rs:43:10
[INFO] [stderr]    |
[INFO] [stderr] 43 | #[derive(Debug)]
[INFO] [stderr]    |          ^^^^^
[INFO] [stderr] 
[INFO] [stderr] warning: 15 warnings emitted
[INFO] [stderr] 
[INFO] [stderr]     Finished dev [unoptimized + debuginfo] target(s) in 3.47s
[INFO] running `Command { std: "docker" "inspect" "641cef144c91dce11b512b073c9bfcde576f6a7baecd44f4d3a988214979f62f", kill_on_drop: false }`
[INFO] running `Command { std: "docker" "rm" "-f" "641cef144c91dce11b512b073c9bfcde576f6a7baecd44f4d3a988214979f62f", kill_on_drop: false }`
[INFO] [stdout] 641cef144c91dce11b512b073c9bfcde576f6a7baecd44f4d3a988214979f62f