├── .gitignore ├── .travis.yml ├── src ├── sys │ ├── mod.rs │ ├── unix.rs │ └── windows.rs └── lib.rs ├── Cargo.toml ├── .appveyor.yml ├── LICENSE-MIT ├── README.md └── LICENSE-APACHE /.gitignore: -------------------------------------------------------------------------------- 1 | target 2 | Cargo.lock 3 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: rust 2 | 3 | -------------------------------------------------------------------------------- /src/sys/mod.rs: -------------------------------------------------------------------------------- 1 | #[cfg(unix)] 2 | mod unix; 3 | #[cfg(windows)] 4 | mod windows; 5 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "vecio" 3 | description = "Vector IO, scatter/gather, writev, readv" 4 | keywords = ["writev", "readv", "vector", "io"] 5 | version = "0.1.0" 6 | authors = ["Sean McArthur "] 7 | license = "MIT OR Apache-2.0" 8 | repository = "https://github.com/seanmonstar/vecio" 9 | 10 | [target.'cfg(windows)'.dependencies] 11 | winapi = "0.2" 12 | ws2_32-sys = "0.2" 13 | -------------------------------------------------------------------------------- /.appveyor.yml: -------------------------------------------------------------------------------- 1 | environment: 2 | matrix: 3 | - TARGET: x86_64-pc-windows-msvc 4 | - TARGET: i686-pc-windows-msvc 5 | - TARGET: x86_64-pc-windows-gnu 6 | - TARGET: i686-pc-windows-gnu 7 | install: 8 | - ps: Start-FileDownload "https://static.rust-lang.org/dist/rust-nightly-${env:TARGET}.exe" -FileName "rust-nightly.exe" 9 | - ps: .\rust-nightly.exe /VERYSILENT /NORESTART /DIR="C:\rust" | Out-Null 10 | - ps: $env:PATH="$env:PATH;C:\rust\bin" 11 | - rustc -vV 12 | - cargo -vV 13 | build: false 14 | test_script: 15 | - cargo test --verbose --no-default-features 16 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | //! # vecio 2 | //! 3 | //! Vector IO operations, commonly referred to as scatter/gather IO. 4 | 5 | #![cfg_attr(test, deny(warnings))] 6 | 7 | use std::io; 8 | 9 | mod sys; 10 | 11 | pub trait Writev { 12 | fn writev(&mut self, buffers: &[&[u8]]) -> io::Result; 13 | } 14 | 15 | pub trait Readv { 16 | fn readv(&mut self, buffers: &[&mut [u8]]) -> io::Result; 17 | } 18 | 19 | pub trait Rawv { 20 | fn readv(&mut self, buffers: &[&mut [u8]]) -> io::Result; 21 | fn writev(&mut self, buffers: &[&[u8]]) -> io::Result; 22 | } 23 | -------------------------------------------------------------------------------- /LICENSE-MIT: -------------------------------------------------------------------------------- 1 | Copyright (c) 2015 Sean McArthur 2 | 3 | Permission is hereby granted, free of charge, to any person obtaining a copy 4 | of this software and associated documentation files (the "Software"), to deal 5 | in the Software without restriction, including without limitation the rights 6 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 7 | copies of the Software, and to permit persons to whom the Software is 8 | furnished to do so, subject to the following conditions: 9 | 10 | The above copyright notice and this permission notice shall be included in 11 | all copies or substantial portions of the Software. 12 | 13 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 18 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 19 | THE SOFTWARE. 20 | 21 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # vecio 2 | 3 | [![Unix Status](https://travis-ci.org/seanmonstar/vecio.svg?branch=master)](https://travis-ci.org/seanmonstar/vecio) 4 | [![Windows status](https://ci.appveyor.com/api/projects/status/kpxw3a297l822sb6?svg=true)](https://ci.appveyor.com/project/seanmonstar/vecio) 5 | [![crates.io](http://meritbadge.herokuapp.com/vecio)](https://crates.io/crates/vecio) 6 | 7 | Vector IO, scatter/gather, readv, writev 8 | 9 | Works on file descriptors on Unix, and sockets on Windows. 10 | 11 | ## Example 12 | 13 | ```rust 14 | extern crate vecio; 15 | 16 | use vecio::Rawv; 17 | use std::net::TcpStream; 18 | 19 | fn main() { 20 | let mut stream = TcpStream::connect("0.0.0.0").unwrap(); 21 | stream.writev(&[b"foo", b"bar"]).unwrap(); 22 | } 23 | ``` 24 | 25 | ## Details 26 | 27 | There are 3 traits of import in `vecio`: 28 | 29 | - `Rawv` 30 | - `Writev` 31 | - `Readv` 32 | 33 | The `Rawv` trait implements `Writev` and `Readv` for any type that implements either `AsRawFd` or `AsRawSocket` (unix and windows). 34 | 35 | The `Writev` and `Readv` traits exist so that any type that needs a custom implementation can have one. 36 | 37 | In simple cases, just import `vecio::Rawv` will give the methods on the proper types. 38 | 39 | ## License 40 | 41 | Licensed under either of 42 | 43 | * [Apache License, Version 2.0](LICENSE-APACHE) 44 | * [MIT license](LICENSE-MIT) 45 | 46 | at your option. 47 | 48 | ### Contribution 49 | 50 | 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. 51 | -------------------------------------------------------------------------------- /src/sys/unix.rs: -------------------------------------------------------------------------------- 1 | use std::io; 2 | use std::os::raw::{c_int, c_void}; 3 | use std::os::unix::io::{AsRawFd, RawFd}; 4 | 5 | use ::{Rawv, Writev, Readv}; 6 | 7 | struct UnixFd(RawFd); 8 | 9 | impl Rawv for T { 10 | fn readv(&mut self, buffers: &[&mut [u8]]) -> io::Result { 11 | UnixFd(self.as_raw_fd()).readv(buffers) 12 | } 13 | 14 | fn writev(&mut self, buffers: &[&[u8]]) -> io::Result { 15 | UnixFd(self.as_raw_fd()).writev(buffers) 16 | } 17 | } 18 | 19 | impl Writev for UnixFd { 20 | fn writev(&mut self, buffers: &[&[u8]]) -> io::Result { 21 | unsafe { 22 | let ret = writev(self.0, buffers.as_ptr() as *const IoVec, buffers.len() as c_int); 23 | if ret == -1 { 24 | Err(io::Error::last_os_error()) 25 | } else { 26 | Ok(ret as usize) 27 | } 28 | } 29 | } 30 | } 31 | 32 | 33 | impl Readv for UnixFd { 34 | fn readv(&mut self, buffers: &[&mut [u8]]) -> io::Result { 35 | unsafe { 36 | let ret = readv(self.0, buffers.as_ptr() as *const IoVec, buffers.len() as c_int); 37 | if ret == -1 { 38 | Err(io::Error::last_os_error()) 39 | } else { 40 | Ok(ret as usize) 41 | } 42 | } 43 | } 44 | } 45 | 46 | #[repr(C)] 47 | struct IoVec { 48 | iov_base: *mut c_void, 49 | iov_len: c_int, 50 | 51 | } 52 | 53 | extern { 54 | fn readv(fd: RawFd, bufs: *const IoVec, count: c_int) -> c_int; 55 | fn writev(fd: RawFd, bufs: *const IoVec, count: c_int) -> c_int; 56 | } 57 | 58 | #[test] 59 | fn test_unix() { 60 | use std::io::Write; 61 | use std::fs::File; 62 | let mut f = File::create("foo.txt").unwrap(); 63 | assert_eq!(f.writev(&[b"foo", b"bar"]).unwrap(), 6); 64 | f.flush().unwrap(); 65 | 66 | let mut f = File::open("foo.txt").unwrap(); 67 | 68 | let mut first = [0u8; 2]; 69 | let mut second = [0u8; 4]; 70 | assert_eq!(f.readv(&[&mut first, &mut second]).unwrap(), 6); 71 | assert_eq!(&first, b"fo"); 72 | assert_eq!(&second, b"obar"); 73 | } 74 | -------------------------------------------------------------------------------- /src/sys/windows.rs: -------------------------------------------------------------------------------- 1 | extern crate winapi; 2 | extern crate ws2_32; 3 | 4 | use std::io; 5 | use std::os::windows::io::{AsRawSocket, RawSocket}; 6 | 7 | use self::winapi::{ULONG, DWORD, WSABUF, LPWSABUF}; 8 | 9 | use self::ws2_32::{WSASend, WSARecv}; 10 | 11 | use ::{Rawv, Writev, Readv}; 12 | 13 | struct WinSock(RawSocket); 14 | 15 | impl Rawv for T { 16 | fn readv(&mut self, buffers: &[&mut [u8]]) -> io::Result { 17 | WinSock(self.as_raw_socket()).readv(buffers) 18 | } 19 | 20 | fn writev(&mut self, buffers: &[&[u8]]) -> io::Result { 21 | WinSock(self.as_raw_socket()).writev(buffers) 22 | } 23 | } 24 | 25 | impl Writev for WinSock { 26 | fn writev(&mut self, buffers: &[&[u8]]) -> io::Result { 27 | unsafe { 28 | let mut wsabufs = Vec::with_capacity(buffers.len()); 29 | for buf in buffers { 30 | wsabufs.push(WSABUF { 31 | buf: buf.as_ptr() as *mut _, 32 | len: buf.len() as ULONG 33 | }); 34 | } 35 | let mut bytes = 0; 36 | let ret = WSASend( 37 | self.0, 38 | wsabufs.as_ptr() as LPWSABUF, 39 | wsabufs.len() as DWORD, 40 | &mut bytes, 41 | 0, 42 | 0 as *mut _, 43 | None 44 | ); 45 | if ret != 0 { 46 | Err(io::Error::last_os_error()) 47 | } else { 48 | Ok(bytes as usize) 49 | } 50 | } 51 | } 52 | } 53 | 54 | 55 | impl Readv for WinSock { 56 | fn readv(&mut self, buffers: &[&mut [u8]]) -> io::Result { 57 | unsafe { 58 | let mut wsabufs = Vec::with_capacity(buffers.len()); 59 | for buf in buffers { 60 | wsabufs.push(WSABUF { 61 | buf: buf.as_ptr() as *mut _, 62 | len: buf.len() as ULONG 63 | }); 64 | } 65 | let mut bytes = 0; 66 | let mut flags = 0; 67 | let ret = WSARecv( 68 | self.0, 69 | wsabufs.as_ptr() as LPWSABUF, 70 | wsabufs.len() as DWORD, 71 | &mut bytes, 72 | &mut flags, 73 | 0 as *mut _, 74 | None 75 | ); 76 | if ret != 0 { 77 | Err(io::Error::last_os_error()) 78 | } else { 79 | Ok(ret as usize) 80 | } 81 | } 82 | } 83 | } 84 | 85 | #[test] 86 | fn test_rawv() { 87 | use std::net::{TcpListener, TcpStream}; 88 | use std::thread; 89 | 90 | let acceptor = TcpListener::bind("127.0.0.1:3444").unwrap(); 91 | let addr = acceptor.local_addr().unwrap(); 92 | 93 | thread::spawn(move || { 94 | let mut outgoing = TcpStream::connect(addr).unwrap(); 95 | outgoing.writev(&[b"foo", b"bar"]).unwrap(); 96 | }); 97 | 98 | let (mut incoming, _) = acceptor.accept().unwrap(); 99 | let mut one = [0u8; 2]; 100 | let mut two = [0u8; 4]; 101 | 102 | incoming.readv(&[&mut one, &mut two]).unwrap(); 103 | assert_eq!(&one, b"fo"); 104 | assert_eq!(&two, b"obar"); 105 | } 106 | -------------------------------------------------------------------------------- /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 | Copyright 2015-2016 Sean McArthur 179 | 180 | Licensed under the Apache License, Version 2.0 (the "License"); 181 | you may not use this file except in compliance with the License. 182 | You may obtain a copy of the License at 183 | 184 | http://www.apache.org/licenses/LICENSE-2.0 185 | 186 | Unless required by applicable law or agreed to in writing, software 187 | distributed under the License is distributed on an "AS IS" BASIS, 188 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 189 | See the License for the specific language governing permissions and 190 | limitations under the License. 191 | --------------------------------------------------------------------------------