1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
mod flush; mod write; mod write_all; mod write_vectored; use flush::FlushFuture; use write::WriteFuture; use write_all::WriteAllFuture; use write_vectored::WriteVectoredFuture; use cfg_if::cfg_if; use crate::io::IoSlice; use crate::utils::extension_trait; cfg_if! { if #[cfg(feature = "docs")] { use std::pin::Pin; use std::ops::{Deref, DerefMut}; use crate::io; use crate::task::{Context, Poll}; } } extension_trait! { #[doc = r#" Allows writing to a byte stream. This trait is a re-export of [`futures::io::AsyncWrite`] and is an async version of [`std::io::Write`]. Methods other than [`poll_write`], [`poll_write_vectored`], [`poll_flush`], and [`poll_close`] do not really exist in the trait itself, but they become available when the prelude is imported: ``` # #[allow(unused_imports)] use async_std::prelude::*; ``` [`std::io::Write`]: https://doc.rust-lang.org/std/io/trait.Write.html [`futures::io::AsyncWrite`]: https://docs.rs/futures-preview/0.3.0-alpha.17/futures/io/trait.AsyncWrite.html [`poll_write`]: #tymethod.poll_write [`poll_write_vectored`]: #method.poll_write_vectored [`poll_flush`]: #tymethod.poll_flush [`poll_close`]: #tymethod.poll_close "#] pub trait Write [WriteExt: futures_io::AsyncWrite] { #[doc = r#" Attempt to write bytes from `buf` into the object. "#] fn poll_write( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<io::Result<usize>>; #[doc = r#" Attempt to write bytes from `bufs` into the object using vectored IO operations. "#] fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>] ) -> Poll<io::Result<usize>> { unreachable!("this impl only appears in the rendered docs") } #[doc = r#" Attempt to flush the object, ensuring that any buffered data reach their destination. "#] fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>>; #[doc = r#" Attempt to close the object. "#] fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>>; #[doc = r#" Writes some bytes into the byte stream. Returns the number of bytes written from the start of the buffer. If the return value is `Ok(n)` then it must be guaranteed that `0 <= n <= buf.len()`. A return value of `0` typically means that the underlying object is no longer able to accept bytes and will likely not be able to in the future as well, or that the buffer provided is empty. # Examples ```no_run # fn main() -> std::io::Result<()> { async_std::task::block_on(async { # use async_std::fs::File; use async_std::prelude::*; let mut file = File::create("a.txt").await?; let n = file.write(b"hello world").await?; # # Ok(()) }) } ``` "#] fn write<'a>( &'a mut self, buf: &'a [u8], ) -> impl Future<Output = io::Result<usize>> + 'a [WriteFuture<'a, Self>] where Self: Unpin, { WriteFuture { writer: self, buf } } #[doc = r#" Flushes the stream to ensure that all buffered contents reach their destination. # Examples ```no_run # fn main() -> std::io::Result<()> { async_std::task::block_on(async { # use async_std::fs::File; use async_std::prelude::*; let mut file = File::create("a.txt").await?; file.write_all(b"hello world").await?; file.flush().await?; # # Ok(()) }) } ``` "#] fn flush(&mut self) -> impl Future<Output = io::Result<()>> + '_ [FlushFuture<'_, Self>] where Self: Unpin, { FlushFuture { writer: self } } #[doc = r#" Like [`write`], except that it writes from a slice of buffers. Data is copied from each buffer in order, with the final buffer read from possibly being only partially consumed. This method must behave as a call to [`write`] with the buffers concatenated would. The default implementation calls [`write`] with either the first nonempty buffer provided, or an empty one if none exists. [`write`]: #tymethod.write "#] fn write_vectored<'a>( &'a mut self, bufs: &'a [IoSlice<'a>], ) -> impl Future<Output = io::Result<usize>> + 'a [WriteVectoredFuture<'a, Self>] where Self: Unpin, { WriteVectoredFuture { writer: self, bufs } } #[doc = r#" Writes an entire buffer into the byte stream. This method will continuously call [`write`] until there is no more data to be written or an error is returned. This method will not return until the entire buffer has been successfully written or such an error occurs. [`write`]: #tymethod.write # Examples ```no_run # fn main() -> std::io::Result<()> { async_std::task::block_on(async { # use async_std::fs::File; use async_std::prelude::*; let mut file = File::create("a.txt").await?; file.write_all(b"hello world").await?; # # Ok(()) }) } ``` [`write`]: #tymethod.write "#] fn write_all<'a>( &'a mut self, buf: &'a [u8], ) -> impl Future<Output = io::Result<()>> + 'a [WriteAllFuture<'a, Self>] where Self: Unpin, { WriteAllFuture { writer: self, buf } } } impl<T: Write + Unpin + ?Sized> Write for Box<T> { fn poll_write( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<io::Result<usize>> { unreachable!("this impl only appears in the rendered docs") } fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>> { unreachable!("this impl only appears in the rendered docs") } fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>> { unreachable!("this impl only appears in the rendered docs") } } impl<T: Write + Unpin + ?Sized> Write for &mut T { fn poll_write( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<io::Result<usize>> { unreachable!("this impl only appears in the rendered docs") } fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>> { unreachable!("this impl only appears in the rendered docs") } fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>> { unreachable!("this impl only appears in the rendered docs") } } impl<P> Write for Pin<P> where P: DerefMut + Unpin, <P as Deref>::Target: Write, { fn poll_write( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<io::Result<usize>> { unreachable!("this impl only appears in the rendered docs") } fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>> { unreachable!("this impl only appears in the rendered docs") } fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>> { unreachable!("this impl only appears in the rendered docs") } } impl Write for Vec<u8> { fn poll_write( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<io::Result<usize>> { unreachable!("this impl only appears in the rendered docs") } fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>> { unreachable!("this impl only appears in the rendered docs") } fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>> { unreachable!("this impl only appears in the rendered docs") } } }