fd-lock-3.0.13/.cargo_vcs_info.json0000644000000001360000000000100124370ustar { "git": { "sha1": "d61edf72b755925998fdec033acb98ae02c2aa10" }, "path_in_vcs": "" }fd-lock-3.0.13/.github/CODE_OF_CONDUCT.md000064400000000000000000000061521046102023000153720ustar 00000000000000# Contributor Covenant Code of Conduct ## Our Pledge In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. ## Our Standards Examples of behavior that contributes to creating a positive environment include: - Using welcoming and inclusive language - Being respectful of differing viewpoints and experiences - Gracefully accepting constructive criticism - Focusing on what is best for the community - Showing empathy towards other community members Examples of unacceptable behavior by participants include: - The use of sexualized language or imagery and unwelcome sexual attention or advances - Trolling, insulting/derogatory comments, and personal or political attacks - Public or private harassment - Publishing others' private information, such as a physical or electronic address, without explicit permission - Other conduct which could reasonably be considered inappropriate in a professional setting ## Our Responsibilities Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. ## Scope This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at yoshuawuyts@gmail.com, or through IRC. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. ## Attribution This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html fd-lock-3.0.13/.github/CONTRIBUTING.md000064400000000000000000000051771046102023000150320ustar 00000000000000# Contributing Contributions include code, documentation, answering user questions, running the project's infrastructure, and advocating for all types of users. The project welcomes all contributions from anyone willing to work in good faith with other contributors and the community. No contribution is too small and all contributions are valued. This guide explains the process for contributing to the project's GitHub Repository. - [Code of Conduct](#code-of-conduct) - [Bad Actors](#bad-actors) ## Code of Conduct The project has a [Code of Conduct](./CODE_OF_CONDUCT.md) that *all* contributors are expected to follow. This code describes the *minimum* behavior expectations for all contributors. As a contributor, how you choose to act and interact towards your fellow contributors, as well as to the community, will reflect back not only on yourself but on the project as a whole. The Code of Conduct is designed and intended, above all else, to help establish a culture within the project that allows anyone and everyone who wants to contribute to feel safe doing so. Should any individual act in any way that is considered in violation of the [Code of Conduct](./CODE_OF_CONDUCT.md), corrective actions will be taken. It is possible, however, for any individual to *act* in such a manner that is not in violation of the strict letter of the Code of Conduct guidelines while still going completely against the spirit of what that Code is intended to accomplish. Open, diverse, and inclusive communities live and die on the basis of trust. Contributors can disagree with one another so long as they trust that those disagreements are in good faith and everyone is working towards a common goal. ## Bad Actors All contributors to tacitly agree to abide by both the letter and spirit of the [Code of Conduct](./CODE_OF_CONDUCT.md). Failure, or unwillingness, to do so will result in contributions being respectfully declined. A *bad actor* is someone who repeatedly violates the *spirit* of the Code of Conduct through consistent failure to self-regulate the way in which they interact with other contributors in the project. In doing so, bad actors alienate other contributors, discourage collaboration, and generally reflect poorly on the project as a whole. Being a bad actor may be intentional or unintentional. Typically, unintentional bad behavior can be easily corrected by being quick to apologize and correct course *even if you are not entirely convinced you need to*. Giving other contributors the benefit of the doubt and having a sincere willingness to admit that you *might* be wrong is critical for any successful open collaboration. Don't be a bad actor. fd-lock-3.0.13/.github/workflows/ci.yaml000064400000000000000000000023151046102023000161040ustar 00000000000000name: CI on: pull_request: push: branches: - staging - trying env: RUSTFLAGS: -Dwarnings jobs: build_and_test: name: Build and test runs-on: ${{ matrix.os }} strategy: matrix: os: [ubuntu-latest, windows-latest, macOS-latest] rust: [stable] steps: - uses: actions/checkout@v3 - name: Install ${{ matrix.rust }} uses: actions-rs/toolchain@v1 with: toolchain: ${{ matrix.rust }} override: true - name: check uses: actions-rs/cargo@v1 with: command: check args: --all --bins --examples - name: check unstable uses: actions-rs/cargo@v1 with: command: check args: --all --benches --bins --examples --tests - name: tests uses: actions-rs/cargo@v1 with: command: test args: --all check_fmt_and_docs: name: Checking fmt and docs runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - uses: actions-rs/toolchain@v1 with: toolchain: nightly components: rustfmt, clippy override: true - name: fmt run: cargo fmt --all -- --check - name: Docs run: cargo doc fd-lock-3.0.13/.gitignore000064400000000000000000000001011046102023000132070ustar 00000000000000coverage/ target/ tmp/ dist/ npm-debug.log* Cargo.lock .DS_Store fd-lock-3.0.13/Cargo.toml0000644000000024640000000000100104430ustar # THIS FILE IS AUTOMATICALLY GENERATED BY CARGO # # When uploading crates to the registry Cargo will automatically # "normalize" Cargo.toml files for maximal compatibility # with all versions of Cargo and also rewrite `path` dependencies # to registry (e.g., crates.io) dependencies. # # If you are reading this file be aware that the original Cargo.toml # will likely look very different (and much more reasonable). # See Cargo.toml.orig for the original contents. [package] edition = "2018" name = "fd-lock" version = "3.0.13" authors = ["Yoshua Wuyts "] description = "Advisory cross-platform lock on a file using a file descriptor to it." documentation = "https://docs.rs/fd-lock" readme = "README.md" keywords = [ "file", "fd", "lock", "windows", "unix", ] categories = [ "filesystem", "os", "os::macos-apis", "os::unix-apis", "os::windows-apis", ] license = "MIT OR Apache-2.0" repository = "https://github.com/yoshuawuyts/fd-lock" [dependencies.cfg-if] version = "1.0.0" [dev-dependencies.tempfile] version = "3.0.8" [target."cfg(unix)".dependencies.rustix] version = "0.38.0" features = ["fs"] [target."cfg(windows)".dependencies.windows-sys] version = "0.48.0" features = [ "Win32_Foundation", "Win32_Storage_FileSystem", "Win32_System_IO", ] fd-lock-3.0.13/Cargo.toml.orig000064400000000000000000000014521046102023000141200ustar 00000000000000[package] name = "fd-lock" version = "3.0.13" license = "MIT OR Apache-2.0" repository = "https://github.com/yoshuawuyts/fd-lock" documentation = "https://docs.rs/fd-lock" description = "Advisory cross-platform lock on a file using a file descriptor to it." keywords = ["file", "fd", "lock", "windows", "unix"] categories = ["filesystem", "os", "os::macos-apis", "os::unix-apis", "os::windows-apis"] authors = ["Yoshua Wuyts "] readme = "README.md" edition = "2018" [dependencies] cfg-if = "1.0.0" [target.'cfg(windows)'.dependencies.windows-sys] version = "0.48.0" features = [ "Win32_Foundation", "Win32_Storage_FileSystem", "Win32_System_IO", ] [target.'cfg(unix)'.dependencies] rustix = { version = "0.38.0", features = ["fs"] } [dev-dependencies] tempfile = "3.0.8" fd-lock-3.0.13/LICENSE-APACHE000064400000000000000000000250051046102023000131550ustar 00000000000000 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS Copyright 2019 Yoshua Wuyts Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. fd-lock-3.0.13/LICENSE-MIT000064400000000000000000000020671046102023000126700ustar 00000000000000The MIT License (MIT) Copyright (c) 2019 Yoshua Wuyts Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. fd-lock-3.0.13/README.md000064400000000000000000000047461046102023000125210ustar 00000000000000# fd-lock [![crates.io version][1]][2] [![downloads][5]][6] [![docs.rs docs][7]][8] Advisory cross-platform file locks using file descriptors. Adapted from [mafintosh/fd-lock]. Note that advisory lock compliance is opt-in, and can freely be ignored by other parties. This means this crate __should never be used for security purposes__, but solely to coordinate file access. [mafintosh/fd-lock]: https://github.com/mafintosh/fd-lock - [Documentation][8] - [Crates.io][2] - [Releases][releases] ## Examples __Basic usage__ ```rust use std::io::prelude::*; use std::fs::File; use fd_lock::RwLock; // Lock a file and write to it. let mut f = RwLock::new(File::open("foo.txt")?); write!(f.write()?, "chashu cat")?; // A lock can also be held across multiple operations. let mut f = f.write()?; write!(f, "nori cat")?; write!(f, "bird!")?; ``` ## Installation ```sh $ cargo add fd-lock ``` ## Safety This crate uses `unsafe` on Windows to interface with `windows-sys`. All invariants have been carefully checked, and are manually enforced. ## Contributing Want to join us? Check out our ["Contributing" guide][contributing] and take a look at some of these issues: - [Issues labeled "good first issue"][good-first-issue] - [Issues labeled "help wanted"][help-wanted] ## References - [LockFile function - WDC](https://docs.microsoft.com/en-us/windows/desktop/api/fileapi/nf-fileapi-lockfile) - [flock(2) - Linux Man Page](https://man7.org/linux/man-pages/man2/flock.2.html) - [`rustix::fs::flock`](https://docs.rs/rustix/*/rustix/fs/fn.flock.html) - [`windows_sys::Win32::Storage::FileSystem::LockFile`](https://microsoft.github.io/windows-docs-rs/doc/windows/Win32/Storage/FileSystem/fn.LockFile.html) ## License [MIT](./LICENSE-MIT) OR [Apache-2.0](./LICENSE-APACHE) [1]: https://img.shields.io/crates/v/fd-lock.svg?style=flat-square [2]: https://crates.io/crates/fd-lock [3]: https://img.shields.io/travis/yoshuawuyts/fd-lock/master.svg?style=flat-square [4]: https://travis-ci.org/yoshuawuyts/fd-lock [5]: https://img.shields.io/crates/d/fd-lock.svg?style=flat-square [6]: https://crates.io/crates/fd-lock [7]: https://img.shields.io/badge/docs-latest-blue.svg?style=flat-square [8]: https://docs.rs/fd-lock [releases]: https://github.com/yoshuawuyts/fd-lock/releases [contributing]: https://github.com/yoshuawuyts/fd-lock/blob/master.github/CONTRIBUTING.md [good-first-issue]: https://github.com/yoshuawuyts/fd-lock/labels/good%20first%20issue [help-wanted]: https://github.com/yoshuawuyts/fd-lock/labels/help%20wanted fd-lock-3.0.13/src/lib.rs000064400000000000000000000022751046102023000131400ustar 00000000000000//! Advisory reader-writer locks for files. //! //! # Notes on Advisory Locks //! //! "advisory locks" are locks which programs must opt-in to adhere to. This //! means that they can be used to coordinate file access, but not prevent //! access. Use this to coordinate file access between multiple instances of the //! same program. But do not use this to prevent actors from accessing or //! modifying files. //! //! # Example //! //! ```no_run //! # use std::io; //! use std::io::prelude::*; //! use std::fs::File; //! use fd_lock::RwLock; //! //! # fn main() -> io::Result<()> { //! // Lock a file and write to it. //! let mut f = RwLock::new(File::open("foo.txt")?); //! write!(f.write()?, "chashu cat")?; //! //! // A lock can also be held across multiple operations. //! let mut f = f.write()?; //! write!(f, "nori cat")?; //! write!(f, "bird!")?; //! # Ok(()) } //! ``` #![forbid(future_incompatible)] #![deny(missing_debug_implementations, nonstandard_style)] #![cfg_attr(doc, warn(missing_docs, rustdoc::missing_doc_code_examples))] mod read_guard; mod rw_lock; mod write_guard; pub(crate) mod sys; pub use read_guard::RwLockReadGuard; pub use rw_lock::RwLock; pub use write_guard::RwLockWriteGuard; fd-lock-3.0.13/src/read_guard.rs000064400000000000000000000016601046102023000144640ustar 00000000000000use std::ops; use crate::sys; /// RAII structure used to release the shared read access of a lock when /// dropped. /// /// This structure is created by the [`read`] and [`try_read`] methods on /// [`RwLock`]. /// /// [`read`]: crate::RwLock::read /// [`try_read`]: crate::RwLock::try_read /// [`RwLock`]: crate::RwLock #[must_use = "if unused the RwLock will immediately unlock"] #[derive(Debug)] pub struct RwLockReadGuard<'lock, T: sys::AsRaw> { guard: sys::RwLockReadGuard<'lock, T>, } impl<'lock, T: sys::AsRaw> RwLockReadGuard<'lock, T> { pub(crate) fn new(guard: sys::RwLockReadGuard<'lock, T>) -> Self { Self { guard } } } impl ops::Deref for RwLockReadGuard<'_, T> { type Target = T; #[inline] fn deref(&self) -> &Self::Target { self.guard.deref() } } /// Release the lock. impl Drop for RwLockReadGuard<'_, T> { #[inline] fn drop(&mut self) {} } fd-lock-3.0.13/src/rw_lock.rs000064400000000000000000000103161046102023000140250ustar 00000000000000use crate::read_guard::RwLockReadGuard; use crate::sys; use crate::write_guard::RwLockWriteGuard; use std::io; /// Advisory reader-writer lock for files. /// /// This type of lock allows a number of readers or at most one writer at any point /// in time. The write portion of this lock typically allows modification of the /// underlying data (exclusive access) and the read portion of this lock typically /// allows for read-only access (shared access). #[derive(Debug)] pub struct RwLock { lock: sys::RwLock, } impl RwLock { /// Create a new instance. /// /// # Examples /// /// ```no_run /// use fd_lock::RwLock; /// use std::fs::File; /// /// fn main() -> std::io::Result<()> { /// let mut f = RwLock::new(File::open("foo.txt")?); /// Ok(()) /// } /// ``` #[inline] pub fn new(inner: T) -> Self { Self { lock: sys::RwLock::new(inner), } } /// Locks this lock with shared read access, blocking the current thread /// until it can be acquired. /// /// The calling thread will be blocked until there are no more writers which /// hold the lock. There may be other readers currently inside the lock when /// this method returns. This method does not provide any guarantees with /// respect to the ordering of whether contentious readers or writers will /// acquire the lock first. /// /// Returns an RAII guard which will release this thread's shared access /// once it is dropped. /// /// # Errors /// /// On Unix this may return an `ErrorKind::Interrupted` if the operation was /// interrupted by a signal handler. #[inline] pub fn read(&self) -> io::Result> { let guard = self.lock.read()?; Ok(RwLockReadGuard::new(guard)) } /// Attempts to acquire this lock with shared read access. /// /// If the access could not be granted at this time, then `Err` is returned. /// Otherwise, an RAII guard is returned which will release the shared access /// when it is dropped. /// /// This function does not block. /// /// This function does not provide any guarantees with respect to the ordering /// of whether contentious readers or writers will acquire the lock first. /// /// # Errors /// /// If the lock is already held and `ErrorKind::WouldBlock` error is returned. /// On Unix this may return an `ErrorKind::Interrupted` if the operation was /// interrupted by a signal handler. #[inline] pub fn try_read(&self) -> io::Result> { let guard = self.lock.try_read()?; Ok(RwLockReadGuard::new(guard)) } /// Locks this lock with exclusive write access, blocking the current thread /// until it can be acquired. /// /// This function will not return while other writers or other readers /// currently have access to the lock. /// /// Returns an RAII guard which will drop the write access of this rwlock /// when dropped. /// /// # Errors /// /// On Unix this may return an `ErrorKind::Interrupted` if the operation was /// interrupted by a signal handler. #[inline] pub fn write(&mut self) -> io::Result> { let guard = self.lock.write()?; Ok(RwLockWriteGuard::new(guard)) } /// Attempts to lock this lock with exclusive write access. /// /// If the lock could not be acquired at this time, then `Err` is returned. /// Otherwise, an RAII guard is returned which will release the lock when /// it is dropped. /// /// # Errors /// /// If the lock is already held and `ErrorKind::WouldBlock` error is returned. /// On Unix this may return an `ErrorKind::Interrupted` if the operation was /// interrupted by a signal handler. #[inline] pub fn try_write(&mut self) -> io::Result> { let guard = self.lock.try_write()?; Ok(RwLockWriteGuard::new(guard)) } /// Consumes this `RwLock`, returning the underlying data. #[inline] pub fn into_inner(self) -> T where T: Sized, { self.lock.into_inner() } } fd-lock-3.0.13/src/sys/mod.rs000064400000000000000000000006371046102023000137670ustar 00000000000000use cfg_if::cfg_if; cfg_if! { if #[cfg(unix)] { mod unix; pub use unix::*; pub(crate) use std::os::unix::prelude::AsRawFd as AsRaw; } else if #[cfg(windows)] { mod windows; pub use windows::*; #[doc(no_inline)] pub(crate) use std::os::windows::prelude::AsRawHandle as AsRaw; } else { mod unsupported; pub use unsupported; } } fd-lock-3.0.13/src/sys/unix/mod.rs000064400000000000000000000002241046102023000147420ustar 00000000000000mod read_guard; mod rw_lock; mod write_guard; pub use read_guard::RwLockReadGuard; pub use rw_lock::RwLock; pub use write_guard::RwLockWriteGuard; fd-lock-3.0.13/src/sys/unix/read_guard.rs000064400000000000000000000012471046102023000162660ustar 00000000000000use rustix::fs::{flock, FlockOperation}; use std::ops; use std::os::unix::io::AsRawFd; use super::RwLock; #[derive(Debug)] pub struct RwLockReadGuard<'lock, T: AsRawFd> { lock: &'lock RwLock, } impl<'lock, T: AsRawFd> RwLockReadGuard<'lock, T> { pub(crate) fn new(lock: &'lock RwLock) -> Self { Self { lock } } } impl ops::Deref for RwLockReadGuard<'_, T> { type Target = T; #[inline] fn deref(&self) -> &Self::Target { &self.lock.inner } } impl Drop for RwLockReadGuard<'_, T> { #[inline] fn drop(&mut self) { let _ = flock(&self.lock.as_fd(), FlockOperation::Unlock).ok(); } } fd-lock-3.0.13/src/sys/unix/rw_lock.rs000064400000000000000000000040051046102023000156240ustar 00000000000000use rustix::fd::BorrowedFd; use rustix::fs::{flock, FlockOperation}; use std::io::{self, Error, ErrorKind}; use std::os::unix::io::AsRawFd; use super::{RwLockReadGuard, RwLockWriteGuard}; #[derive(Debug)] pub struct RwLock { pub(crate) inner: T, } impl RwLock { #[inline] pub fn new(inner: T) -> Self { RwLock { inner } } #[inline] pub fn write(&mut self) -> io::Result> { flock(&self.as_fd(), FlockOperation::LockExclusive)?; Ok(RwLockWriteGuard::new(self)) } #[inline] pub fn try_write(&mut self) -> Result, Error> { flock(&self.as_fd(), FlockOperation::NonBlockingLockExclusive).map_err(|err| match err .kind() { ErrorKind::AlreadyExists => ErrorKind::WouldBlock.into(), _ => Error::from(err), })?; Ok(RwLockWriteGuard::new(self)) } #[inline] pub fn read(&self) -> io::Result> { flock(&self.as_fd(), FlockOperation::LockShared)?; Ok(RwLockReadGuard::new(self)) } #[inline] pub fn try_read(&self) -> Result, Error> { flock(&self.as_fd(), FlockOperation::NonBlockingLockShared).map_err(|err| { match err.kind() { ErrorKind::AlreadyExists => ErrorKind::WouldBlock.into(), _ => Error::from(err), } })?; Ok(RwLockReadGuard::new(self)) } #[inline] pub fn into_inner(self) -> T where T: Sized, { self.inner } #[inline] pub(crate) fn as_fd(&self) -> BorrowedFd<'_> { // Safety: We assume that `self.inner`'s file descriptor is valid for // at least the lifetime of `self`. // // Once I/O safety is stablized in std, we can switch the public API to // use `AsFd` instead of `AsRawFd` and eliminate this `unsafe` block. unsafe { BorrowedFd::borrow_raw(self.inner.as_raw_fd()) } } } fd-lock-3.0.13/src/sys/unix/write_guard.rs000064400000000000000000000015271046102023000165060ustar 00000000000000use rustix::fs::{flock, FlockOperation}; use std::ops; use std::os::unix::io::AsRawFd; use super::RwLock; #[derive(Debug)] pub struct RwLockWriteGuard<'lock, T: AsRawFd> { lock: &'lock mut RwLock, } impl<'lock, T: AsRawFd> RwLockWriteGuard<'lock, T> { pub(crate) fn new(lock: &'lock mut RwLock) -> Self { Self { lock } } } impl ops::Deref for RwLockWriteGuard<'_, T> { type Target = T; #[inline] fn deref(&self) -> &Self::Target { &self.lock.inner } } impl ops::DerefMut for RwLockWriteGuard<'_, T> { #[inline] fn deref_mut(&mut self) -> &mut Self::Target { &mut self.lock.inner } } impl Drop for RwLockWriteGuard<'_, T> { #[inline] fn drop(&mut self) { let _ = flock(&self.lock.as_fd(), FlockOperation::Unlock).ok(); } } fd-lock-3.0.13/src/sys/unsupported/mod.rs000064400000000000000000000002531046102023000163510ustar 00000000000000mod read_guard; mod rw_lock; mod write_guard; pub(crate) mod utils; pub use read_guard::RwLockReadGuard; pub use rw_lock::RwLock; pub use write_guard::RwLockWriteGuard; fd-lock-3.0.13/src/sys/unsupported/read_guard.rs000064400000000000000000000011661046102023000176730ustar 00000000000000use std::ops; use std::os::unix::io::AsRawFd; use super::RwLock; #[derive(Debug)] pub struct RwLockReadGuard<'lock, T: AsRawFd> { lock: &'lock RwLock, } impl<'lock, T: AsRawFd> RwLockReadGuard<'lock, T> { pub(crate) fn new(lock: &'lock RwLock) -> Self { panic!("target unsupported") } } impl ops::Deref for RwLockReadGuard<'_, T> { type Target = T; #[inline] fn deref(&self) -> &Self::Target { panic!("target unsupported") } } impl Drop for RwLockReadGuard<'_, T> { #[inline] fn drop(&mut self) { panic!("target unsupported") } } fd-lock-3.0.13/src/sys/unsupported/rw_lock.rs000064400000000000000000000016741046102023000172420ustar 00000000000000use std::io::{self, Error, ErrorKind}; use std::os::unix::io::AsRawFd; use super::{RwLockReadGuard, RwLockWriteGuard}; #[derive(Debug)] pub struct RwLock { pub(crate) inner: T, } impl RwLock { #[inline] pub fn new(inner: T) -> Self { panic!("target unsupported") } #[inline] pub fn write(&mut self) -> io::Result> { panic!("target unsupported") } #[inline] pub fn try_write(&mut self) -> Result, Error> { panic!("target unsupported") } #[inline] pub fn read(&self) -> io::Result> { panic!("target unsupported") } #[inline] pub fn try_read(&self) -> Result, Error> { panic!("target unsupported") } #[inline] pub fn into_inner(self) -> T where T: Sized, { panic!("target unsupported") } } fd-lock-3.0.13/src/sys/unsupported/utils.rs000064400000000000000000000002701046102023000167310ustar 00000000000000use std::io; use std::os::raw::c_int; pub(crate) fn syscall(int: c_int) -> io::Result<()> { match int { 0 => Ok(()), _ => Err(io::Error::last_os_error()), } } fd-lock-3.0.13/src/sys/unsupported/write_guard.rs000064400000000000000000000014561046102023000201140ustar 00000000000000use std::ops; use std::os::unix::io::AsRawFd; use super::RwLock; #[derive(Debug)] pub struct RwLockWriteGuard<'lock, T: AsRawFd> { lock: &'lock mut RwLock, } impl<'lock, T: AsRawFd> RwLockWriteGuard<'lock, T> { pub(crate) fn new(lock: &'lock mut RwLock) -> Self { panic!("target unsupported") } } impl ops::Deref for RwLockWriteGuard<'_, T> { type Target = T; #[inline] fn deref(&self) -> &Self::Target { panic!("target unsupported") } } impl ops::DerefMut for RwLockWriteGuard<'_, T> { #[inline] fn deref_mut(&mut self) -> &mut Self::Target { panic!("target unsupported") } } impl Drop for RwLockWriteGuard<'_, T> { #[inline] fn drop(&mut self) { panic!("target unsupported") } } fd-lock-3.0.13/src/sys/windows/mod.rs000064400000000000000000000002371046102023000154550ustar 00000000000000mod read_guard; mod rw_lock; mod utils; mod write_guard; pub use read_guard::RwLockReadGuard; pub use rw_lock::RwLock; pub use write_guard::RwLockWriteGuard; fd-lock-3.0.13/src/sys/windows/read_guard.rs000064400000000000000000000013111046102023000167650ustar 00000000000000use windows_sys::Win32::Foundation::HANDLE; use windows_sys::Win32::Storage::FileSystem::UnlockFile; use std::ops; use std::os::windows::prelude::*; use super::utils::syscall; use super::RwLock; #[derive(Debug)] pub struct RwLockReadGuard<'lock, T: AsRawHandle> { pub(crate) lock: &'lock RwLock, } impl ops::Deref for RwLockReadGuard<'_, T> { type Target = T; #[inline] fn deref(&self) -> &Self::Target { &self.lock.inner } } impl Drop for RwLockReadGuard<'_, T> { #[inline] fn drop(&mut self) { let handle = self.lock.inner.as_raw_handle() as HANDLE; let _ = syscall(unsafe { UnlockFile(handle, 0, 0, 1, 0) }); } } fd-lock-3.0.13/src/sys/windows/rw_lock.rs000064400000000000000000000055071046102023000163430ustar 00000000000000use std::io::{self, Error, ErrorKind}; use std::os::windows::io::AsRawHandle; use windows_sys::Win32::Foundation::ERROR_LOCK_VIOLATION; use windows_sys::Win32::Foundation::HANDLE; use windows_sys::Win32::Storage::FileSystem::{ LockFileEx, LOCKFILE_EXCLUSIVE_LOCK, LOCKFILE_FAIL_IMMEDIATELY, }; use super::utils::{syscall, Overlapped}; use super::{RwLockReadGuard, RwLockWriteGuard}; #[derive(Debug)] pub struct RwLock { pub(crate) inner: T, } impl RwLock { #[inline] pub fn new(inner: T) -> Self { RwLock { inner } } #[inline] pub fn read(&self) -> io::Result> { // See: https://stackoverflow.com/a/9186532, https://docs.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-lockfileex let handle = self.inner.as_raw_handle() as HANDLE; let overlapped = Overlapped::zero(); let flags = 0; syscall(unsafe { LockFileEx(handle, flags, 0, 1, 0, overlapped.raw()) })?; Ok(RwLockReadGuard { lock: self }) } #[inline] pub fn try_read(&self) -> io::Result> { let handle = self.inner.as_raw_handle() as HANDLE; let overlapped = Overlapped::zero(); let flags = LOCKFILE_FAIL_IMMEDIATELY; syscall(unsafe { LockFileEx(handle, flags, 0, 1, 0, overlapped.raw()) }).map_err( |error| match error.raw_os_error().map(|error_code| error_code as u32) { Some(ERROR_LOCK_VIOLATION) => Error::from(ErrorKind::WouldBlock), _ => error, }, )?; Ok(RwLockReadGuard { lock: self }) } #[inline] pub fn write(&mut self) -> io::Result> { // See: https://stackoverflow.com/a/9186532, https://docs.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-lockfileex let handle = self.inner.as_raw_handle() as HANDLE; let overlapped = Overlapped::zero(); let flags = LOCKFILE_EXCLUSIVE_LOCK; syscall(unsafe { LockFileEx(handle, flags, 0, 1, 0, overlapped.raw()) })?; Ok(RwLockWriteGuard { lock: self }) } #[inline] pub fn try_write(&mut self) -> io::Result> { let handle = self.inner.as_raw_handle() as HANDLE; let overlapped = Overlapped::zero(); let flags = LOCKFILE_FAIL_IMMEDIATELY | LOCKFILE_EXCLUSIVE_LOCK; syscall(unsafe { LockFileEx(handle, flags, 0, 1, 0, overlapped.raw()) }).map_err( |error| match error.raw_os_error().map(|error_code| error_code as u32) { Some(ERROR_LOCK_VIOLATION) => Error::from(ErrorKind::WouldBlock), _ => error, }, )?; Ok(RwLockWriteGuard { lock: self }) } #[inline] pub fn into_inner(self) -> T where T: Sized, { self.inner } } fd-lock-3.0.13/src/sys/windows/utils.rs000064400000000000000000000016501046102023000160360ustar 00000000000000use std::io; use std::mem; use windows_sys::Win32::Foundation::BOOL; use windows_sys::Win32::System::IO::OVERLAPPED; /// A wrapper around `OVERLAPPED` to provide "rustic" accessors and /// initializers. pub(crate) struct Overlapped(OVERLAPPED); impl Overlapped { /// Creates a new zeroed out instance of an overlapped I/O tracking state. /// /// This is suitable for passing to methods which will then later get /// notified via an I/O Completion Port. pub(crate) fn zero() -> Overlapped { Overlapped(unsafe { mem::zeroed() }) } /// Gain access to the raw underlying data pub(crate) fn raw(&self) -> *mut OVERLAPPED { &self.0 as *const _ as *mut _ } } /// Convert a system call which returns a `BOOL` to an `io::Result`. pub(crate) fn syscall(status: BOOL) -> std::io::Result<()> { if status == 0 { Err(io::Error::last_os_error()) } else { Ok(()) } } fd-lock-3.0.13/src/sys/windows/write_guard.rs000064400000000000000000000015701046102023000172130ustar 00000000000000use windows_sys::Win32::Foundation::HANDLE; use windows_sys::Win32::Storage::FileSystem::UnlockFile; use std::ops; use std::os::windows::prelude::*; use super::utils::syscall; use super::RwLock; #[derive(Debug)] pub struct RwLockWriteGuard<'lock, T: AsRawHandle> { pub(crate) lock: &'lock mut RwLock, } impl ops::Deref for RwLockWriteGuard<'_, T> { type Target = T; #[inline] fn deref(&self) -> &Self::Target { &self.lock.inner } } impl ops::DerefMut for RwLockWriteGuard<'_, T> { #[inline] fn deref_mut(&mut self) -> &mut Self::Target { &mut self.lock.inner } } impl Drop for RwLockWriteGuard<'_, T> { #[inline] fn drop(&mut self) { let handle = self.lock.inner.as_raw_handle() as HANDLE; let _ = syscall(unsafe { UnlockFile(handle, 0, 0, 1, 0) }); } } fd-lock-3.0.13/src/write_guard.rs000064400000000000000000000021511046102023000146770ustar 00000000000000use std::ops; use crate::sys; /// RAII structure used to release the exclusive write access of a lock when /// dropped. /// /// This structure is created by the [`write`] and [`try_write`] methods /// on [`RwLock`]. /// /// [`write`]: crate::RwLock::write /// [`try_write`]: crate::RwLock::try_write /// [`RwLock`]: crate::RwLock #[must_use = "if unused the RwLock will immediately unlock"] #[derive(Debug)] pub struct RwLockWriteGuard<'lock, T: sys::AsRaw> { guard: sys::RwLockWriteGuard<'lock, T>, } impl<'lock, T: sys::AsRaw> RwLockWriteGuard<'lock, T> { pub(crate) fn new(guard: sys::RwLockWriteGuard<'lock, T>) -> Self { Self { guard } } } impl ops::Deref for RwLockWriteGuard<'_, T> { type Target = T; #[inline] fn deref(&self) -> &Self::Target { self.guard.deref() } } impl ops::DerefMut for RwLockWriteGuard<'_, T> { #[inline] fn deref_mut(&mut self) -> &mut Self::Target { self.guard.deref_mut() } } /// Release the lock. impl Drop for RwLockWriteGuard<'_, T> { #[inline] fn drop(&mut self) {} } fd-lock-3.0.13/tests/test.rs000064400000000000000000000045271046102023000137260ustar 00000000000000use fd_lock::RwLock; use std::fs::File; use std::io::ErrorKind; use tempfile::tempdir; #[test] fn double_read_lock() { let dir = tempdir().unwrap(); let path = dir.path().join("lockfile"); let l0 = RwLock::new(File::create(&path).unwrap()); let l1 = RwLock::new(File::open(path).unwrap()); let _g0 = l0.try_read().unwrap(); let _g1 = l1.try_read().unwrap(); } #[test] fn double_write_lock() { let dir = tempdir().unwrap(); let path = dir.path().join("lockfile"); let mut l0 = RwLock::new(File::create(&path).unwrap()); let mut l1 = RwLock::new(File::open(path).unwrap()); let g0 = l0.try_write().unwrap(); let err = l1.try_write().unwrap_err(); assert!(matches!(err.kind(), ErrorKind::WouldBlock)); drop(g0); } #[test] fn read_and_write_lock() { let dir = tempdir().unwrap(); let path = dir.path().join("lockfile"); let l0 = RwLock::new(File::create(&path).unwrap()); let mut l1 = RwLock::new(File::open(path).unwrap()); let g0 = l0.try_read().unwrap(); let err = l1.try_write().unwrap_err(); assert!(matches!(err.kind(), ErrorKind::WouldBlock)); drop(g0); } #[test] fn write_and_read_lock() { let dir = tempdir().unwrap(); let path = dir.path().join("lockfile"); let mut l0 = RwLock::new(File::create(&path).unwrap()); let l1 = RwLock::new(File::open(path).unwrap()); let g0 = l0.try_write().unwrap(); let err = l1.try_read().unwrap_err(); assert!(matches!(err.kind(), ErrorKind::WouldBlock)); drop(g0); } #[cfg(windows)] mod windows { use super::*; use std::os::windows::fs::OpenOptionsExt; #[test] fn try_lock_error() { let dir = tempdir().unwrap(); let path = dir.path().join("lockfile"); // On Windows, opening with an access_mode as 0 will prevent all locking operations from succeeding, simulating an I/O error. let mut l0 = RwLock::new( File::options() .create(true) .read(true) .write(true) .access_mode(0) .open(path) .unwrap(), ); let err1 = l0.try_read().unwrap_err(); assert!(matches!(err1.kind(), ErrorKind::PermissionDenied)); let err2 = l0.try_write().unwrap_err(); assert!(matches!(err2.kind(), ErrorKind::PermissionDenied)); } }