├── .github ├── dependabot.yml └── workflows │ ├── ci.yml │ └── release.yml ├── .gitignore ├── CHANGELOG.md ├── Cargo.toml ├── LICENSE-APACHE ├── LICENSE-MIT ├── README.md └── src └── lib.rs /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: cargo 4 | directory: / 5 | schedule: 6 | interval: weekly 7 | commit-message: 8 | prefix: '' 9 | labels: [] 10 | -------------------------------------------------------------------------------- /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | permissions: 4 | contents: read 5 | 6 | on: 7 | pull_request: 8 | push: 9 | branches: 10 | - master 11 | schedule: 12 | - cron: '0 2 * * 0' 13 | 14 | env: 15 | CARGO_INCREMENTAL: 0 16 | CARGO_NET_GIT_FETCH_WITH_CLI: true 17 | CARGO_NET_RETRY: 10 18 | CARGO_TERM_COLOR: always 19 | RUST_BACKTRACE: 1 20 | RUSTFLAGS: -D warnings 21 | RUSTDOCFLAGS: -D warnings 22 | RUSTUP_MAX_RETRIES: 10 23 | 24 | defaults: 25 | run: 26 | shell: bash 27 | 28 | jobs: 29 | fmt: 30 | uses: smol-rs/.github/.github/workflows/fmt.yml@main 31 | security_audit: 32 | uses: smol-rs/.github/.github/workflows/security_audit.yml@main 33 | permissions: 34 | checks: write 35 | contents: read 36 | issues: write 37 | secrets: inherit 38 | 39 | test: 40 | runs-on: ${{ matrix.os }} 41 | strategy: 42 | fail-fast: false 43 | matrix: 44 | os: [ubuntu-latest] 45 | rust: [nightly, beta, stable] 46 | steps: 47 | - uses: actions/checkout@v4 48 | - name: Install Rust 49 | run: rustup update ${{ matrix.rust }} && rustup default ${{ matrix.rust }} 50 | - run: cargo build --all --all-features --all-targets 51 | - name: Run cargo check (without dev-dependencies to catch missing feature flags) 52 | if: startsWith(matrix.rust, 'nightly') 53 | run: cargo check -Z features=dev_dep 54 | - run: cargo test 55 | 56 | msrv: 57 | runs-on: ubuntu-latest 58 | steps: 59 | - uses: actions/checkout@v4 60 | - name: Install cargo-hack 61 | uses: taiki-e/install-action@cargo-hack 62 | - run: cargo hack build --rust-version 63 | 64 | clippy: 65 | runs-on: ubuntu-latest 66 | steps: 67 | - uses: actions/checkout@v4 68 | - name: Install Rust 69 | run: rustup update stable 70 | - run: cargo clippy --all-features --all-targets 71 | -------------------------------------------------------------------------------- /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | name: Release 2 | 3 | permissions: 4 | contents: write 5 | 6 | on: 7 | push: 8 | tags: 9 | - v[0-9]+.* 10 | 11 | jobs: 12 | create-release: 13 | if: github.repository_owner == 'smol-rs' 14 | runs-on: ubuntu-latest 15 | steps: 16 | - uses: actions/checkout@v4 17 | - uses: taiki-e/create-gh-release-action@v1 18 | with: 19 | changelog: CHANGELOG.md 20 | branch: master 21 | env: 22 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 23 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | Cargo.lock 3 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Version 1.2.4 2 | 3 | - Use the `async-lock` crate as the locking mechanism. (#14) 4 | 5 | # Version 1.2.3 6 | 7 | - Remove the unnecessary `simple-mutex` dependency. (#10) 8 | 9 | # Version 1.2.2 10 | 11 | - Fix typos in the docs. 12 | 13 | # Version 1.2.1 14 | 15 | - Forbid unsafe code. 16 | 17 | # Version 1.2.0 18 | 19 | - Make the inner `std::sync::Arc` public. 20 | 21 | # Version 1.1.0 22 | 23 | - Implement `AsyncSeek` for `Arc`, `Mutex`, and `&Mutex`. 24 | 25 | # Version 1.0.1 26 | 27 | - Fix failing tests. 28 | 29 | # Version 1.0.0 30 | 31 | - Initial version 32 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "async-dup" 3 | # When publishing a new version: 4 | # - Update CHANGELOG.md 5 | # - Create "v1.x.y" git tag 6 | version = "1.2.4" 7 | authors = ["Stjepan Glavina "] 8 | edition = "2021" 9 | rust-version = "1.60" 10 | description = "Duplicate an async I/O handle" 11 | license = "Apache-2.0 OR MIT" 12 | repository = "https://github.com/smol-rs/async-dup" 13 | homepage = "https://github.com/smol-rs/async-dup" 14 | documentation = "https://docs.rs/async-dup" 15 | keywords = ["asynchronous", "duplicate", "clone", "split", "share"] 16 | categories = ["asynchronous", "concurrency"] 17 | exclude = ["/.*"] 18 | 19 | [dependencies] 20 | async-lock = "3.1.0" 21 | futures-io = "0.3.5" 22 | 23 | [dev-dependencies] 24 | futures = { version = "0.3.5", default-features = false, features = ["std"] } 25 | smol = "2" 26 | -------------------------------------------------------------------------------- /LICENSE-APACHE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /LICENSE-MIT: -------------------------------------------------------------------------------- 1 | Permission is hereby granted, free of charge, to any 2 | person obtaining a copy of this software and associated 3 | documentation files (the "Software"), to deal in the 4 | Software without restriction, including without 5 | limitation the rights to use, copy, modify, merge, 6 | publish, distribute, sublicense, and/or sell copies of 7 | the Software, and to permit persons to whom the Software 8 | is furnished to do so, subject to the following 9 | conditions: 10 | 11 | The above copyright notice and this permission notice 12 | shall be included in all copies or substantial portions 13 | of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF 16 | ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED 17 | TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 18 | PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT 19 | SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 20 | CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 21 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR 22 | IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 23 | DEALINGS IN THE SOFTWARE. 24 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # async-dup 2 | 3 | [![Build](https://github.com/smol-rs/async-dup/workflows/Build%20and%20test/badge.svg)]( 4 | https://github.com/smol-rs/async-dup/actions) 5 | [![License](https://img.shields.io/badge/license-Apache--2.0_OR_MIT-blue.svg)]( 6 | https://github.com/smol-rs/async-dup) 7 | [![Cargo](https://img.shields.io/crates/v/async-dup.svg)]( 8 | https://crates.io/crates/async-dup) 9 | [![Documentation](https://docs.rs/async-dup/badge.svg)]( 10 | https://docs.rs/async-dup) 11 | 12 | Duplicate an async I/O handle. 13 | 14 | This crate provides two tools, `Arc` and `Mutex`: 15 | 16 | * `Arc` implements `AsyncRead`, `AsyncWrite`, and `AsyncSeek` if a reference to the inner type does. 17 | * A reference to `Mutex` implements `AsyncRead`, `AsyncWrite`, and `AsyncSeek` if the inner type does. 18 | 19 | Wrap an async I/O handle in `Arc` or `Mutex` to clone it or share among tasks. 20 | 21 | ## Examples 22 | 23 | Clone an async I/O handle: 24 | 25 | ```rust 26 | use async_dup::Arc; 27 | use futures::io; 28 | use smol::Async; 29 | use std::net::TcpStream; 30 | 31 | // A client that echoes messages back to the server. 32 | let stream = Async::::connect("127.0.0.1:8000").await?; 33 | 34 | // Create two handles to the stream. 35 | let reader = Arc::new(stream); 36 | let mut writer = reader.clone(); 37 | 38 | // Echo data received from the reader back into the writer. 39 | io::copy(reader, &mut writer).await?; 40 | ``` 41 | 42 | Share an async I/O handle: 43 | 44 | ```rust 45 | use async_dup::Mutex; 46 | use futures::io; 47 | use futures::prelude::*; 48 | 49 | // Reads data from a stream and echoes it back. 50 | async fn echo(stream: impl AsyncRead + AsyncWrite + Unpin) -> io::Result { 51 | let stream = Mutex::new(stream); 52 | io::copy(&stream, &mut &stream).await 53 | } 54 | ``` 55 | 56 | ## License 57 | 58 | Licensed under either of 59 | 60 | * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) 61 | * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) 62 | 63 | at your option. 64 | 65 | #### Contribution 66 | 67 | Unless you explicitly state otherwise, any contribution intentionally submitted 68 | for inclusion in the work by you, as defined in the Apache-2.0 license, shall be 69 | dual licensed as above, without any additional terms or conditions. 70 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | //! Duplicate an async I/O handle. 2 | //! 3 | //! This crate provides two tools, [`Arc`] and [`Mutex`]: 4 | //! 5 | //! * [`Arc`] implements [`AsyncRead`], [`AsyncWrite`], and [`AsyncSeek`] if a reference to the 6 | //! inner type does. 7 | //! * A reference to [`Mutex`] implements [`AsyncRead`], [`AsyncWrite`], and [`AsyncSeek`] if the 8 | //! inner type does. 9 | //! 10 | //! Wrap an async I/O handle in [`Arc`] or [`Mutex`] to clone it or share among tasks. 11 | //! 12 | //! # Examples 13 | //! 14 | //! Clone an async I/O handle: 15 | //! 16 | //! ```no_run 17 | //! use async_dup::Arc; 18 | //! use futures::io; 19 | //! use smol::Async; 20 | //! use std::net::TcpStream; 21 | //! 22 | //! # fn main() -> std::io::Result<()> { smol::block_on(async { 23 | //! // A client that echoes messages back to the server. 24 | //! let stream = Async::::connect(([127, 0, 0, 1], 8000)).await?; 25 | //! 26 | //! // Create two handles to the stream. 27 | //! let reader = Arc::new(stream); 28 | //! let mut writer = reader.clone(); 29 | //! 30 | //! // Echo data received from the reader back into the writer. 31 | //! io::copy(reader, &mut writer).await?; 32 | //! # Ok(()) }) } 33 | //! ``` 34 | //! 35 | //! Share an async I/O handle: 36 | //! 37 | //! ``` 38 | //! use async_dup::Mutex; 39 | //! use futures::io; 40 | //! use futures::prelude::*; 41 | //! 42 | //! // Reads data from a stream and echoes it back. 43 | //! async fn echo(stream: impl AsyncRead + AsyncWrite + Unpin) -> io::Result { 44 | //! let stream = Mutex::new(stream); 45 | //! io::copy(&stream, &mut &stream).await 46 | //! } 47 | //! ``` 48 | 49 | #![forbid(unsafe_code)] 50 | #![warn(missing_docs, missing_debug_implementations, rust_2018_idioms)] 51 | #![doc( 52 | html_favicon_url = "https://raw.githubusercontent.com/smol-rs/smol/master/assets/images/logo_fullsize_transparent.png" 53 | )] 54 | #![doc( 55 | html_logo_url = "https://raw.githubusercontent.com/smol-rs/smol/master/assets/images/logo_fullsize_transparent.png" 56 | )] 57 | 58 | use std::fmt; 59 | use std::hash::{Hash, Hasher}; 60 | use std::io::{self, IoSlice, IoSliceMut, SeekFrom}; 61 | use std::ops::{Deref, DerefMut}; 62 | use std::pin::Pin; 63 | use std::task::{Context, Poll}; 64 | 65 | use futures_io::{AsyncRead, AsyncSeek, AsyncWrite}; 66 | 67 | /// A reference-counted pointer that implements async I/O traits. 68 | /// 69 | /// This is just a wrapper around [`std::sync::Arc`] that adds the following impls: 70 | /// 71 | /// - `impl AsyncRead for Arc where &T: AsyncRead {}` 72 | /// - `impl AsyncWrite for Arc where &T: AsyncWrite {}` 73 | /// - `impl AsyncSeek for Arc where &T: AsyncSeek {}` 74 | pub struct Arc(pub std::sync::Arc); 75 | 76 | impl Unpin for Arc {} 77 | 78 | impl Arc { 79 | /// Constructs a new `Arc`. 80 | /// 81 | /// # Examples 82 | /// 83 | /// ``` 84 | /// use async_dup::Arc; 85 | /// 86 | /// let a = Arc::new(7); 87 | /// ``` 88 | pub fn new(data: T) -> Arc { 89 | Arc(std::sync::Arc::new(data)) 90 | } 91 | } 92 | 93 | impl Clone for Arc { 94 | fn clone(&self) -> Arc { 95 | Arc(self.0.clone()) 96 | } 97 | } 98 | 99 | impl Deref for Arc { 100 | type Target = T; 101 | 102 | #[inline] 103 | fn deref(&self) -> &Self::Target { 104 | &self.0 105 | } 106 | } 107 | 108 | impl fmt::Debug for Arc { 109 | fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { 110 | fmt::Debug::fmt(&**self, f) 111 | } 112 | } 113 | 114 | impl fmt::Display for Arc { 115 | fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { 116 | fmt::Display::fmt(&**self, f) 117 | } 118 | } 119 | 120 | impl Hash for Arc { 121 | fn hash(&self, state: &mut H) { 122 | (**self).hash(state) 123 | } 124 | } 125 | 126 | impl fmt::Pointer for Arc { 127 | fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { 128 | fmt::Pointer::fmt(&(&**self as *const T), f) 129 | } 130 | } 131 | 132 | impl Default for Arc { 133 | fn default() -> Arc { 134 | Arc::new(Default::default()) 135 | } 136 | } 137 | 138 | impl From for Arc { 139 | fn from(t: T) -> Arc { 140 | Arc::new(t) 141 | } 142 | } 143 | 144 | // NOTE(stjepang): It would also make sense to have the following impls: 145 | // 146 | // - `impl AsyncRead for &Arc where &T: AsyncRead {}` 147 | // - `impl AsyncWrite for &Arc where &T: AsyncWrite {}` 148 | // - `impl AsyncSeek for &Arc where &T: AsyncSeek {}` 149 | // 150 | // However, those impls sometimes make Rust's type inference try too hard when types cannot be 151 | // inferred. In the end, instead of complaining with a nice error message, the Rust compiler ends 152 | // up overflowing and dumping a very long error message spanning multiple screens. 153 | // 154 | // Since those impls are not essential, I decided to err on the safe side and not include them. 155 | 156 | impl AsyncRead for Arc 157 | where 158 | for<'a> &'a T: AsyncRead, 159 | { 160 | fn poll_read( 161 | self: Pin<&mut Self>, 162 | cx: &mut Context<'_>, 163 | buf: &mut [u8], 164 | ) -> Poll> { 165 | Pin::new(&mut &*self.0).poll_read(cx, buf) 166 | } 167 | 168 | fn poll_read_vectored( 169 | self: Pin<&mut Self>, 170 | cx: &mut Context<'_>, 171 | bufs: &mut [IoSliceMut<'_>], 172 | ) -> Poll> { 173 | Pin::new(&mut &*self.0).poll_read_vectored(cx, bufs) 174 | } 175 | } 176 | 177 | impl AsyncWrite for Arc 178 | where 179 | for<'a> &'a T: AsyncWrite, 180 | { 181 | fn poll_write( 182 | self: Pin<&mut Self>, 183 | cx: &mut Context<'_>, 184 | buf: &[u8], 185 | ) -> Poll> { 186 | Pin::new(&mut &*self.0).poll_write(cx, buf) 187 | } 188 | 189 | fn poll_write_vectored( 190 | self: Pin<&mut Self>, 191 | cx: &mut Context<'_>, 192 | bufs: &[IoSlice<'_>], 193 | ) -> Poll> { 194 | Pin::new(&mut &*self.0).poll_write_vectored(cx, bufs) 195 | } 196 | 197 | fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { 198 | Pin::new(&mut &*self.0).poll_flush(cx) 199 | } 200 | 201 | fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { 202 | Pin::new(&mut &*self.0).poll_close(cx) 203 | } 204 | } 205 | 206 | impl AsyncSeek for Arc 207 | where 208 | for<'a> &'a T: AsyncSeek, 209 | { 210 | fn poll_seek( 211 | self: Pin<&mut Self>, 212 | cx: &mut Context<'_>, 213 | pos: SeekFrom, 214 | ) -> Poll> { 215 | Pin::new(&mut &*self.0).poll_seek(cx, pos) 216 | } 217 | } 218 | 219 | /// A mutex that implements async I/O traits. 220 | /// 221 | /// This is a blocking mutex that adds the following impls: 222 | /// 223 | /// - `impl AsyncRead for Mutex where T: AsyncRead + Unpin {}` 224 | /// - `impl AsyncRead for &Mutex where T: AsyncRead + Unpin {}` 225 | /// - `impl AsyncWrite for Mutex where T: AsyncWrite + Unpin {}` 226 | /// - `impl AsyncWrite for &Mutex where T: AsyncWrite + Unpin {}` 227 | /// - `impl AsyncSeek for Mutex where T: AsyncSeek + Unpin {}` 228 | /// - `impl AsyncSeek for &Mutex where T: AsyncSeek + Unpin {}` 229 | pub struct Mutex(async_lock::Mutex); 230 | 231 | impl Mutex { 232 | /// Creates a new mutex. 233 | /// 234 | /// # Examples 235 | /// 236 | /// ``` 237 | /// use async_dup::Mutex; 238 | /// 239 | /// let mutex = Mutex::new(10); 240 | /// ``` 241 | pub fn new(data: T) -> Mutex { 242 | Mutex(data.into()) 243 | } 244 | 245 | /// Acquires the mutex, blocking the current thread until it is able to do so. 246 | /// 247 | /// Returns a guard that releases the mutex when dropped. 248 | /// 249 | /// # Examples 250 | /// 251 | /// ``` 252 | /// use async_dup::Mutex; 253 | /// 254 | /// let mutex = Mutex::new(10); 255 | /// let guard = mutex.lock(); 256 | /// assert_eq!(*guard, 10); 257 | /// ``` 258 | pub fn lock(&self) -> MutexGuard<'_, T> { 259 | MutexGuard(self.0.lock_blocking()) 260 | } 261 | 262 | /// Attempts to acquire the mutex. 263 | /// 264 | /// If the mutex could not be acquired at this time, then [`None`] is returned. Otherwise, a 265 | /// guard is returned that releases the mutex when dropped. 266 | /// 267 | /// [`None`]: https://doc.rust-lang.org/std/option/enum.Option.html#variant.None 268 | /// 269 | /// # Examples 270 | /// 271 | /// ``` 272 | /// use async_dup::Mutex; 273 | /// 274 | /// let mutex = Mutex::new(10); 275 | /// if let Some(guard) = mutex.try_lock() { 276 | /// assert_eq!(*guard, 10); 277 | /// } 278 | /// # ; 279 | /// ``` 280 | pub fn try_lock(&self) -> Option> { 281 | self.0.try_lock().map(MutexGuard) 282 | } 283 | 284 | /// Consumes the mutex, returning the underlying data. 285 | /// 286 | /// # Examples 287 | /// 288 | /// ``` 289 | /// use async_dup::Mutex; 290 | /// 291 | /// let mutex = Mutex::new(10); 292 | /// assert_eq!(mutex.into_inner(), 10); 293 | /// ``` 294 | pub fn into_inner(self) -> T { 295 | self.0.into_inner() 296 | } 297 | 298 | /// Returns a mutable reference to the underlying data. 299 | /// 300 | /// Since this call borrows the mutex mutably, no actual locking takes place -- the mutable 301 | /// borrow statically guarantees the mutex is not already acquired. 302 | /// 303 | /// # Examples 304 | /// 305 | /// ``` 306 | /// use async_dup::Mutex; 307 | /// 308 | /// let mut mutex = Mutex::new(0); 309 | /// *mutex.get_mut() = 10; 310 | /// assert_eq!(*mutex.lock(), 10); 311 | /// ``` 312 | pub fn get_mut(&mut self) -> &mut T { 313 | self.0.get_mut() 314 | } 315 | } 316 | 317 | impl fmt::Debug for Mutex { 318 | fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { 319 | struct Locked; 320 | impl fmt::Debug for Locked { 321 | fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { 322 | f.write_str("") 323 | } 324 | } 325 | 326 | match self.try_lock() { 327 | None => f.debug_struct("Mutex").field("data", &Locked).finish(), 328 | Some(guard) => f.debug_struct("Mutex").field("data", &&*guard).finish(), 329 | } 330 | } 331 | } 332 | 333 | impl From for Mutex { 334 | fn from(val: T) -> Mutex { 335 | Mutex::new(val) 336 | } 337 | } 338 | 339 | impl Default for Mutex { 340 | fn default() -> Mutex { 341 | Mutex::new(Default::default()) 342 | } 343 | } 344 | 345 | impl AsyncRead for Mutex { 346 | fn poll_read( 347 | self: Pin<&mut Self>, 348 | cx: &mut Context<'_>, 349 | buf: &mut [u8], 350 | ) -> Poll> { 351 | Pin::new(&mut *self.lock()).poll_read(cx, buf) 352 | } 353 | 354 | fn poll_read_vectored( 355 | self: Pin<&mut Self>, 356 | cx: &mut Context<'_>, 357 | bufs: &mut [IoSliceMut<'_>], 358 | ) -> Poll> { 359 | Pin::new(&mut *self.lock()).poll_read_vectored(cx, bufs) 360 | } 361 | } 362 | 363 | impl AsyncRead for &Mutex { 364 | fn poll_read( 365 | self: Pin<&mut Self>, 366 | cx: &mut Context<'_>, 367 | buf: &mut [u8], 368 | ) -> Poll> { 369 | Pin::new(&mut *self.lock()).poll_read(cx, buf) 370 | } 371 | 372 | fn poll_read_vectored( 373 | self: Pin<&mut Self>, 374 | cx: &mut Context<'_>, 375 | bufs: &mut [IoSliceMut<'_>], 376 | ) -> Poll> { 377 | Pin::new(&mut *self.lock()).poll_read_vectored(cx, bufs) 378 | } 379 | } 380 | 381 | impl AsyncWrite for Mutex { 382 | fn poll_write( 383 | self: Pin<&mut Self>, 384 | cx: &mut Context<'_>, 385 | buf: &[u8], 386 | ) -> Poll> { 387 | Pin::new(&mut *self.lock()).poll_write(cx, buf) 388 | } 389 | 390 | fn poll_write_vectored( 391 | self: Pin<&mut Self>, 392 | cx: &mut Context<'_>, 393 | bufs: &[IoSlice<'_>], 394 | ) -> Poll> { 395 | Pin::new(&mut *self.lock()).poll_write_vectored(cx, bufs) 396 | } 397 | 398 | fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { 399 | Pin::new(&mut *self.lock()).poll_flush(cx) 400 | } 401 | 402 | fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { 403 | Pin::new(&mut *self.lock()).poll_close(cx) 404 | } 405 | } 406 | 407 | impl AsyncWrite for &Mutex { 408 | fn poll_write( 409 | self: Pin<&mut Self>, 410 | cx: &mut Context<'_>, 411 | buf: &[u8], 412 | ) -> Poll> { 413 | Pin::new(&mut *self.lock()).poll_write(cx, buf) 414 | } 415 | 416 | fn poll_write_vectored( 417 | self: Pin<&mut Self>, 418 | cx: &mut Context<'_>, 419 | bufs: &[IoSlice<'_>], 420 | ) -> Poll> { 421 | Pin::new(&mut *self.lock()).poll_write_vectored(cx, bufs) 422 | } 423 | 424 | fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { 425 | Pin::new(&mut *self.lock()).poll_flush(cx) 426 | } 427 | 428 | fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { 429 | Pin::new(&mut *self.lock()).poll_close(cx) 430 | } 431 | } 432 | 433 | impl AsyncSeek for Mutex { 434 | fn poll_seek( 435 | self: Pin<&mut Self>, 436 | cx: &mut Context<'_>, 437 | pos: SeekFrom, 438 | ) -> Poll> { 439 | Pin::new(&mut *self.lock()).poll_seek(cx, pos) 440 | } 441 | } 442 | 443 | impl AsyncSeek for &Mutex { 444 | fn poll_seek( 445 | self: Pin<&mut Self>, 446 | cx: &mut Context<'_>, 447 | pos: SeekFrom, 448 | ) -> Poll> { 449 | Pin::new(&mut *self.lock()).poll_seek(cx, pos) 450 | } 451 | } 452 | 453 | /// A guard that releases the mutex when dropped. 454 | pub struct MutexGuard<'a, T>(async_lock::MutexGuard<'a, T>); 455 | 456 | impl fmt::Debug for MutexGuard<'_, T> { 457 | fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { 458 | fmt::Debug::fmt(&**self, f) 459 | } 460 | } 461 | 462 | impl fmt::Display for MutexGuard<'_, T> { 463 | fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { 464 | (**self).fmt(f) 465 | } 466 | } 467 | 468 | impl Deref for MutexGuard<'_, T> { 469 | type Target = T; 470 | 471 | fn deref(&self) -> &T { 472 | &self.0 473 | } 474 | } 475 | 476 | impl DerefMut for MutexGuard<'_, T> { 477 | fn deref_mut(&mut self) -> &mut T { 478 | &mut self.0 479 | } 480 | } 481 | 482 | #[cfg(test)] 483 | mod tests { 484 | use super::*; 485 | 486 | fn is_send(_: &T) {} 487 | fn is_sync(_: &T) {} 488 | 489 | #[test] 490 | fn is_send_sync() { 491 | let arc = Arc::new(()); 492 | let mutex = Mutex::new(()); 493 | 494 | is_send(&arc); 495 | is_sync(&arc); 496 | 497 | is_send(&mutex); 498 | is_sync(&mutex); 499 | 500 | let guard = mutex.lock(); 501 | is_send(&guard); 502 | is_sync(&guard); 503 | } 504 | } 505 | --------------------------------------------------------------------------------