commit 34842de4541e4c87a1df35a7fe7e2bcbdb9246c0 Author: Stjepan Glavina Date: Sun May 31 16:55:34 2020 +0200 Initial commit diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..e1f75e7 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1 @@ +github: stjepang diff --git a/.github/workflows/build-and-test.yaml b/.github/workflows/build-and-test.yaml new file mode 100644 index 0000000..19d1ebb --- /dev/null +++ b/.github/workflows/build-and-test.yaml @@ -0,0 +1,51 @@ +name: Build and test + +on: + push: + branches: + - master + pull_request: + +jobs: + build_and_test: + runs-on: ${{ matrix.os }} + strategy: + fail-fast: false + matrix: + os: [ubuntu-latest] + rust: [nightly, beta, stable] + steps: + - uses: actions/checkout@v2 + + - name: Set current week of the year in environnement + if: startsWith(matrix.os, 'ubuntu') || startsWith(matrix.os, 'macOS') + run: echo "::set-env name=CURRENT_WEEK::$(date +%V)" + + - name: Set current week of the year in environnement + if: startsWith(matrix.os, 'windows') + run: echo "::set-env name=CURRENT_WEEK::$(Get-Date -UFormat %V)" + + - name: Install latest ${{ matrix.rust }} + uses: actions-rs/toolchain@v1 + with: + toolchain: ${{ matrix.rust }} + profile: minimal + override: true + + - name: Run cargo check + uses: actions-rs/cargo@v1 + with: + command: check + args: --all --bins --examples --tests --all-features + + - name: Run cargo check (without dev-dependencies to catch missing feature flags) + if: startsWith(matrix.rust, 'nightly') + uses: actions-rs/cargo@v1 + with: + command: check + args: -Z features=dev_dep + + - name: Run cargo test + uses: actions-rs/cargo@v1 + with: + command: test diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml new file mode 100644 index 0000000..7e9bd98 --- /dev/null +++ b/.github/workflows/lint.yaml @@ -0,0 +1,26 @@ +name: Lint + +on: + push: + branches: + - master + pull_request: + +jobs: + clippy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + + - name: Set current week of the year in environnement + run: echo "::set-env name=CURRENT_WEEK::$(date +%V)" + + - uses: actions-rs/toolchain@v1 + with: + toolchain: stable + profile: minimal + components: clippy + - uses: actions-rs/clippy-check@v1 + with: + token: ${{ secrets.GITHUB_TOKEN }} + args: --all-features -- -W clippy::all diff --git a/.github/workflows/security.yaml b/.github/workflows/security.yaml new file mode 100644 index 0000000..8f722e7 --- /dev/null +++ b/.github/workflows/security.yaml @@ -0,0 +1,20 @@ +name: Security audit + +on: + push: + branches: + - master + pull_request: + +jobs: + security_audit: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + + - name: Set current week of the year in environnement + run: echo "::set-env name=CURRENT_WEEK::$(date +%V)" + + - uses: actions-rs/audit-check@v1 + with: + token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..96ef6c0 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +/target +Cargo.lock diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..af42cea --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,3 @@ +# Version 1.0.0 + +- Initial version diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..ee21308 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,21 @@ +[package] +name = "async-dup" +version = "1.0.0" +authors = ["Stjepan Glavina "] +edition = "2018" +description = "Duplicate an async I/O handle" +license = "Apache-2.0 OR MIT" +repository = "https://github.com/stjepang/async-dup" +homepage = "https://github.com/stjepang/async-dup" +documentation = "https://docs.rs/async-dup" +keywords = ["asynchronous", "duplicate", "clone", "split", "share"] +categories = ["asynchronous", "concurrency"] +readme = "README.md" + +[dependencies] +futures-io = "0.3.5" +simple-mutex = "1.1.5" + +[dev-dependencies] +futures = { version = "0.3.5", default-features = false, features = ["std"] } +smol = "0.1.10" diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..16fe87b --- /dev/null +++ b/LICENSE-APACHE @@ -0,0 +1,201 @@ + 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 + +APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + +Copyright [yyyy] [name of copyright owner] + +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. diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..31aa793 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,23 @@ +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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..cea5f6e --- /dev/null +++ b/README.md @@ -0,0 +1,69 @@ +# async-dup + +[![Build](https://github.com/stjepang/async-dup/workflows/Build%20and%20test/badge.svg)]( +https://github.com/stjepang/async-dup/actions) +[![License](https://img.shields.io/badge/license-MIT%2FApache--2.0-blue.svg)]( +https://github.com/stjepang/async-dup) +[![Cargo](https://img.shields.io/crates/v/async-dup.svg)]( +https://crates.io/crates/async-dup) +[![Documentation](https://docs.rs/async-dup/badge.svg)]( +https://docs.rs/async-dup) + +Duplicate an async I/O handle. + +This crate provides two tools, `Arc` and `Mutex`: + +* `Arc` implements `AsyncRead` and `AsyncWrite` if a reference to the inner type does. +* A reference to `Mutex` implements `AsyncRead` and `AsyncWrite` if the inner type does. + +Wrap an async I/O handle in `Arc` or `Mutex` to clone it or share among tasks. + +## Examples + +Clone an async I/O handle: + +```rust +use async_dup::Arc; +use futures::io; +use smol::Async; +use std::net::TcpStream; + +// A client that echoes messages back to the server. +let stream = Async::::connect("127.0.0.1:8000").await?; + +// Create two handles to the stream. +let reader = Arc::new(stream); +let mut writer = reader.clone(); + +// Echo data received from the reader back into the writer. +io::copy(reader, &mut writer).await?; +``` + +Share an async I/O handle: + +```rust +use async_dup::Mutex; +use futures::io; +use futures::prelude::*; + +// Reads data from a stream and echoes it back. +async fn echo(stream: impl AsyncRead + AsyncWrite + Unpin) -> io::Result { + let stream = Mutex::new(stream); + io::copy(&stream, &mut &stream).await +} +``` + +## License + +Licensed under either of + + * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) + * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) + +at your option. + +#### Contribution + +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclusion in the work by you, as defined in the Apache-2.0 license, shall be +dual licensed as above, without any additional terms or conditions. diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..2ed5b99 --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,436 @@ +//! Duplicate an async I/O handle. +//! +//! This crate provides two tools, [`Arc`] and [`Mutex`]: +//! +//! * [`Arc`] implements [`AsyncRead`] and [`AsyncWrite`] if a reference to the inner type does. +//! * A reference to [`Mutex`] implements [`AsyncRead`] and [`AsyncWrite`] if the inner type does. +//! +//! Wrap an async I/O handle in [`Arc`] or [`Mutex`] to clone it or share among tasks. +//! +//! # Examples +//! +//! Clone an async I/O handle: +//! +//! ```no_run +//! use async_dup::Arc; +//! use futures::io; +//! use smol::Async; +//! use std::net::TcpStream; +//! +//! // A client that echoes messages back to the server. +//! let stream = Async::::connect("127.0.0.1:8000").await?; +//! +//! // Create two handles to the stream. +//! let reader = Arc::new(stream); +//! let mut writer = reader.clone(); +//! +//! // Echo data received from the reader back into the writer. +//! io::copy(reader, &mut writer).await?; +//! ``` +//! +//! Share an async I/O handle: +//! +//! ``` +//! use async_dup::Mutex; +//! use futures::io; +//! use futures::prelude::*; +//! +//! // Reads data from a stream and echoes it back. +//! async fn echo(stream: impl AsyncRead + AsyncWrite + Unpin) -> io::Result { +//! let stream = Mutex::new(stream); +//! io::copy(&stream, &mut &stream).await +//! } +//! ``` + +#![warn(missing_docs, missing_debug_implementations, rust_2018_idioms)] + +use std::fmt; +use std::hash::{Hash, Hasher}; +use std::io::{self, IoSlice, IoSliceMut}; +use std::ops::{Deref, DerefMut}; +use std::pin::Pin; +use std::task::{Context, Poll}; + +use futures_io::{AsyncRead, AsyncWrite}; + +/// A reference-counted pointer that implements async I/O traits. +/// +/// This is just a wrapper around [`std::sync::Arc`] that adds the following impls: +/// +/// - `impl AsyncRead for Arc where &T: AsyncRead {}` +/// - `impl AsyncWrite for Arc where &T: AsyncWrite {}` +pub struct Arc(std::sync::Arc); + +impl Unpin for Arc {} + +impl Arc { + /// Constructs a new `Arc`. + /// + /// # Examples + /// + /// ``` + /// use async_dup::Arc; + /// + /// let a = Arc::new(7); + /// ``` + pub fn new(data: T) -> Arc { + Arc(std::sync::Arc::new(data)) + } +} + +impl Clone for Arc { + fn clone(&self) -> Arc { + Arc(self.0.clone()) + } +} + +impl Deref for Arc { + type Target = T; + + #[inline] + fn deref(&self) -> &Self::Target { + &self.0 + } +} + +impl fmt::Debug for Arc { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + fmt::Debug::fmt(&**self, f) + } +} + +impl fmt::Display for Arc { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + fmt::Display::fmt(&**self, f) + } +} + +impl Hash for Arc { + fn hash(&self, state: &mut H) { + (**self).hash(state) + } +} + +impl fmt::Pointer for Arc { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + fmt::Pointer::fmt(&(&**self as *const T), f) + } +} + +impl Default for Arc { + fn default() -> Arc { + Arc::new(Default::default()) + } +} + +impl From for Arc { + fn from(t: T) -> Arc { + Arc::new(t) + } +} + +// NOTE(stjepang): It would also make sense to have the following impls: +// +// - `impl AsyncRead for &Arc where &T: AsyncRead {}` +// - `impl AsyncWrite for &Arc where &T: AsyncWrite {}` +// +// However, those impls sometimes make Rust's type inference try too hard when types cannot be +// inferred. In the end, instead of complaining with a nice error message, the Rust compiler ends +// up overflowing and dumping a very long error message spanning multiple screens. +// +// Since those impls are not essential, I decided to err on the safe side and not include them. + +impl AsyncRead for Arc +where + for<'a> &'a T: AsyncRead, +{ + fn poll_read( + self: Pin<&mut Self>, + cx: &mut Context<'_>, + buf: &mut [u8], + ) -> Poll> { + Pin::new(&mut &*self.0).poll_read(cx, buf) + } + + fn poll_read_vectored( + self: Pin<&mut Self>, + cx: &mut Context<'_>, + bufs: &mut [IoSliceMut<'_>], + ) -> Poll> { + Pin::new(&mut &*self.0).poll_read_vectored(cx, bufs) + } +} + +impl AsyncWrite for Arc +where + for<'a> &'a T: AsyncWrite, +{ + fn poll_write( + self: Pin<&mut Self>, + cx: &mut Context<'_>, + buf: &[u8], + ) -> Poll> { + Pin::new(&mut &*self.0).poll_write(cx, buf) + } + + fn poll_write_vectored( + self: Pin<&mut Self>, + cx: &mut Context<'_>, + bufs: &[IoSlice<'_>], + ) -> Poll> { + Pin::new(&mut &*self.0).poll_write_vectored(cx, bufs) + } + + fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + Pin::new(&mut &*self.0).poll_flush(cx) + } + + fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + Pin::new(&mut &*self.0).poll_close(cx) + } +} + +/// A mutex that implements async I/O traits. +/// +/// This is a blocking mutex that adds the following impls: +/// +/// - `impl AsyncRead for Mutex where &T: AsyncRead + Unpin {}` +/// - `impl AsyncRead for &Mutex where &T: AsyncRead + Unpin {}` +/// - `impl AsyncWrite for Mutex where &T: AsyncWrite + Unpin {}` +/// - `impl AsyncWrite for &Mutex where &T: AsyncWrite + Unpin {}` +pub struct Mutex(simple_mutex::Mutex); + +impl Mutex { + /// Creates a new mutex. + /// + /// # Examples + /// + /// ``` + /// use async_dup::Mutex; + /// + /// let mutex = Mutex::new(10); + /// ``` + pub fn new(data: T) -> Mutex { + Mutex(data.into()) + } + + /// Acquires the mutex, blocking the current thread until it is able to do so. + /// + /// Returns a guard that releases the mutex when dropped. + /// + /// # Examples + /// + /// ``` + /// use async_dup::Mutex; + /// + /// let mutex = Mutex::new(10); + /// let guard = mutex.lock(); + /// assert_eq!(*guard, 10); + /// ``` + pub fn lock(&self) -> MutexGuard<'_, T> { + MutexGuard(self.0.lock()) + } + + /// Attempts to acquire the mutex. + /// + /// If the mutex could not be acquired at this time, then [`None`] is returned. Otherwise, a + /// guard is returned that releases the mutex when dropped. + /// + /// [`None`]: https://doc.rust-lang.org/std/option/enum.Option.html#variant.None + /// + /// # Examples + /// + /// ``` + /// use async_dup::Mutex; + /// + /// let mutex = Mutex::new(10); + /// if let Some(guard) = mutex.try_lock() { + /// assert_eq!(*guard, 10); + /// } + /// # ; + /// ``` + pub fn try_lock(&self) -> Option> { + if let Some(guard) = self.0.try_lock() { + Some(MutexGuard(guard)) + } else { + None + } + } + + /// Consumes the mutex, returning the underlying data. + /// + /// # Examples + /// + /// ``` + /// use async_dup::Mutex; + /// + /// let mutex = Mutex::new(10); + /// assert_eq!(mutex.into_inner(), 10); + /// ``` + pub fn into_inner(self) -> T { + self.0.into_inner() + } + + /// Returns a mutable reference to the underlying data. + /// + /// Since this call borrows the mutex mutably, no actual locking takes place -- the mutable + /// borrow statically guarantees the mutex is not already acquired. + /// + /// # Examples + /// + /// ``` + /// use async_dup::Mutex; + /// + /// let mut mutex = Mutex::new(0); + /// *mutex.get_mut() = 10; + /// assert_eq!(*mutex.lock(), 10); + /// ``` + pub fn get_mut(&mut self) -> &mut T { + self.0.get_mut() + } +} + +impl fmt::Debug for Mutex { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + struct Locked; + impl fmt::Debug for Locked { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + f.write_str("") + } + } + + match self.try_lock() { + None => f.debug_struct("Mutex").field("data", &Locked).finish(), + Some(guard) => f.debug_struct("Mutex").field("data", &&*guard).finish(), + } + } +} + +impl From for Mutex { + fn from(val: T) -> Mutex { + Mutex::new(val) + } +} + +impl Default for Mutex { + fn default() -> Mutex { + Mutex::new(Default::default()) + } +} + +impl AsyncRead for Mutex { + fn poll_read( + self: Pin<&mut Self>, + cx: &mut Context<'_>, + buf: &mut [u8], + ) -> Poll> { + Pin::new(&mut *self.lock()).poll_read(cx, buf) + } + + fn poll_read_vectored( + self: Pin<&mut Self>, + cx: &mut Context<'_>, + bufs: &mut [IoSliceMut<'_>], + ) -> Poll> { + Pin::new(&mut *self.lock()).poll_read_vectored(cx, bufs) + } +} + +impl AsyncRead for &Mutex { + fn poll_read( + self: Pin<&mut Self>, + cx: &mut Context<'_>, + buf: &mut [u8], + ) -> Poll> { + Pin::new(&mut *self.lock()).poll_read(cx, buf) + } + + fn poll_read_vectored( + self: Pin<&mut Self>, + cx: &mut Context<'_>, + bufs: &mut [IoSliceMut<'_>], + ) -> Poll> { + Pin::new(&mut *self.lock()).poll_read_vectored(cx, bufs) + } +} + +impl AsyncWrite for Mutex { + fn poll_write( + self: Pin<&mut Self>, + cx: &mut Context<'_>, + buf: &[u8], + ) -> Poll> { + Pin::new(&mut *self.lock()).poll_write(cx, buf) + } + + fn poll_write_vectored( + self: Pin<&mut Self>, + cx: &mut Context<'_>, + bufs: &[IoSlice<'_>], + ) -> Poll> { + Pin::new(&mut *self.lock()).poll_write_vectored(cx, bufs) + } + + fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + Pin::new(&mut *self.lock()).poll_flush(cx) + } + + fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + Pin::new(&mut *self.lock()).poll_close(cx) + } +} + +impl AsyncWrite for &Mutex { + fn poll_write( + self: Pin<&mut Self>, + cx: &mut Context<'_>, + buf: &[u8], + ) -> Poll> { + Pin::new(&mut *self.lock()).poll_write(cx, buf) + } + + fn poll_write_vectored( + self: Pin<&mut Self>, + cx: &mut Context<'_>, + bufs: &[IoSlice<'_>], + ) -> Poll> { + Pin::new(&mut *self.lock()).poll_write_vectored(cx, bufs) + } + + fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + Pin::new(&mut *self.lock()).poll_flush(cx) + } + + fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + Pin::new(&mut *self.lock()).poll_close(cx) + } +} + +/// A guard that releases the mutex when dropped. +pub struct MutexGuard<'a, T>(simple_mutex::MutexGuard<'a, T>); + +impl fmt::Debug for MutexGuard<'_, T> { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + fmt::Debug::fmt(&**self, f) + } +} + +impl fmt::Display for MutexGuard<'_, T> { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + (**self).fmt(f) + } +} + +impl Deref for MutexGuard<'_, T> { + type Target = T; + + fn deref(&self) -> &T { + &self.0 + } +} + +impl DerefMut for MutexGuard<'_, T> { + fn deref_mut(&mut self) -> &mut T { + &mut self.0 + } +}