library/std/src/io/cursor.rs

   1 #[cfg(test)]
   2 mod tests;
   3
   4 use crate::io::prelude::*;
   5
   6 use crate::alloc::Allocator;
   7 use crate::cmp;
   8 use crate::io::{self, ErrorKind, IoSlice, IoSliceMut, ReadBuf, SeekFrom};
   9
  10 /// A `Cursor` wraps an in-memory buffer and provides it with a
  11 /// [`Seek`] implementation.
  12 ///
  13 /// `Cursor`s are used with in-memory buffers, anything implementing
  14 /// <code>[AsRef]<\[u8]></code>, to allow them to implement [`Read`] and/or [`Write`],
  15 /// allowing these buffers to be used anywhere you might use a reader or writer
  16 /// that does actual I/O.
  17 ///
  18 /// The standard library implements some I/O traits on various types which
  19 /// are commonly used as a buffer, like <code>Cursor<[Vec]\<u8>></code> and
  20 /// <code>Cursor<[&\[u8\]][bytes]></code>.
  21 ///
  22 /// # Examples
  23 ///
  24 /// We may want to write bytes to a [`File`] in our production
  25 /// code, but use an in-memory buffer in our tests. We can do this with
  26 /// `Cursor`:
  27 ///
  28 /// [bytes]: crate::slice "slice"
  29 /// [`File`]: crate::fs::File
  30 ///
  31 /// ```no_run
  32 /// use std::io::prelude::*;
  33 /// use std::io::{self, SeekFrom};
  34 /// use std::fs::File;
  35 ///
  36 /// // a library function we've written
  37 /// fn write_ten_bytes_at_end<W: Write + Seek>(writer: &mut W) -> io::Result<()> {
  38 ///     writer.seek(SeekFrom::End(-10))?;
  39 ///
  40 ///     for i in 0..10 {
  41 ///         writer.write(&[i])?;
  42 ///     }
  43 ///
  44 ///     // all went well
  45 ///     Ok(())
  46 /// }
  47 ///
  48 /// # fn foo() -> io::Result<()> {
  49 /// // Here's some code that uses this library function.
  50 /// //
  51 /// // We might want to use a BufReader here for efficiency, but let's
  52 /// // keep this example focused.
  53 /// let mut file = File::create("foo.txt")?;
  54 ///
  55 /// write_ten_bytes_at_end(&mut file)?;
  56 /// # Ok(())
  57 /// # }
  58 ///
  59 /// // now let's write a test
  60 /// #[test]
  61 /// fn test_writes_bytes() {
  62 ///     // setting up a real File is much slower than an in-memory buffer,
  63 ///     // let's use a cursor instead
  64 ///     use std::io::Cursor;
  65 ///     let mut buff = Cursor::new(vec![0; 15]);
  66 ///
  67 ///     write_ten_bytes_at_end(&mut buff).unwrap();
  68 ///
  69 ///     assert_eq!(&buff.get_ref()[5..15], &[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]);
  70 /// }
  71 /// ```
  72 #[stable(feature = "rust1", since = "1.0.0")]
  73 #[derive(Debug, Default, Eq, PartialEq)]
  74 pub struct Cursor<T> {
  75     inner: T,
  76     pos: u64,
  77 }
  78
  79 impl<T> Cursor<T> {
  80     /// Creates a new cursor wrapping the provided underlying in-memory buffer.
  81     ///
  82     /// Cursor initial position is `0` even if underlying buffer (e.g., [`Vec`])
  83     /// is not empty. So writing to cursor starts with overwriting [`Vec`]
  84     /// content, not with appending to it.
  85     ///
  86     /// # Examples
  87     ///
  88     /// ```
  89     /// use std::io::Cursor;
  90     ///
  91     /// let buff = Cursor::new(Vec::new());
  92     /// # fn force_inference(_: &Cursor<Vec<u8>>) {}
  93     /// # force_inference(&buff);
  94     /// ```
  95     #[stable(feature = "rust1", since = "1.0.0")]
  96     #[rustc_const_unstable(feature = "const_io_structs", issue = "78812")]
  97     pub const fn new(inner: T) -> Cursor<T> {
  98         Cursor { pos: 0, inner }
  99     }
 100
 101     /// Consumes this cursor, returning the underlying value.
 102     ///
 103     /// # Examples
 104     ///
 105     /// ```
 106     /// use std::io::Cursor;
 107     ///
 108     /// let buff = Cursor::new(Vec::new());
 109     /// # fn force_inference(_: &Cursor<Vec<u8>>) {}
 110     /// # force_inference(&buff);
 111     ///
 112     /// let vec = buff.into_inner();
 113     /// ```
 114     #[stable(feature = "rust1", since = "1.0.0")]
 115     pub fn into_inner(self) -> T {
 116         self.inner
 117     }
 118
 119     /// Gets a reference to the underlying value in this cursor.
 120     ///
 121     /// # Examples
 122     ///
 123     /// ```
 124     /// use std::io::Cursor;
 125     ///
 126     /// let buff = Cursor::new(Vec::new());
 127     /// # fn force_inference(_: &Cursor<Vec<u8>>) {}
 128     /// # force_inference(&buff);
 129     ///
 130     /// let reference = buff.get_ref();
 131     /// ```
 132     #[stable(feature = "rust1", since = "1.0.0")]
 133     #[rustc_const_unstable(feature = "const_io_structs", issue = "78812")]
 134     pub const fn get_ref(&self) -> &T {
 135         &self.inner
 136     }
 137
 138     /// Gets a mutable reference to the underlying value in this cursor.
 139     ///
 140     /// Care should be taken to avoid modifying the internal I/O state of the
 141     /// underlying value as it may corrupt this cursor's position.
 142     ///
 143     /// # Examples
 144     ///
 145     /// ```
 146     /// use std::io::Cursor;
 147     ///
 148     /// let mut buff = Cursor::new(Vec::new());
 149     /// # fn force_inference(_: &Cursor<Vec<u8>>) {}
 150     /// # force_inference(&buff);
 151     ///
 152     /// let reference = buff.get_mut();
 153     /// ```
 154     #[stable(feature = "rust1", since = "1.0.0")]
 155     pub fn get_mut(&mut self) -> &mut T {
 156         &mut self.inner
 157     }
 158
 159     /// Returns the current position of this cursor.
 160     ///
 161     /// # Examples
 162     ///
 163     /// ```
 164     /// use std::io::Cursor;
 165     /// use std::io::prelude::*;
 166     /// use std::io::SeekFrom;
 167     ///
 168     /// let mut buff = Cursor::new(vec![1, 2, 3, 4, 5]);
 169     ///
 170     /// assert_eq!(buff.position(), 0);
 171     ///
 172     /// buff.seek(SeekFrom::Current(2)).unwrap();
 173     /// assert_eq!(buff.position(), 2);
 174     ///
 175     /// buff.seek(SeekFrom::Current(-1)).unwrap();
 176     /// assert_eq!(buff.position(), 1);
 177     /// ```
 178     #[stable(feature = "rust1", since = "1.0.0")]
 179     #[rustc_const_unstable(feature = "const_io_structs", issue = "78812")]
 180     pub const fn position(&self) -> u64 {
 181         self.pos
 182     }
 183
 184     /// Sets the position of this cursor.
 185     ///
 186     /// # Examples
 187     ///
 188     /// ```
 189     /// use std::io::Cursor;
 190     ///
 191     /// let mut buff = Cursor::new(vec![1, 2, 3, 4, 5]);
 192     ///
 193     /// assert_eq!(buff.position(), 0);
 194     ///
 195     /// buff.set_position(2);
 196     /// assert_eq!(buff.position(), 2);
 197     ///
 198     /// buff.set_position(4);
 199     /// assert_eq!(buff.position(), 4);
 200     /// ```
 201     #[stable(feature = "rust1", since = "1.0.0")]
 202     pub fn set_position(&mut self, pos: u64) {
 203         self.pos = pos;
 204     }
 205 }
 206
 207 impl<T> Cursor<T>
 208 where
 209     T: AsRef<[u8]>,
 210 {
 211     /// Returns the remaining slice.
 212     ///
 213     /// # Examples
 214     ///
 215     /// ```
 216     /// #![feature(cursor_remaining)]
 217     /// use std::io::Cursor;
 218     ///
 219     /// let mut buff = Cursor::new(vec![1, 2, 3, 4, 5]);
 220     ///
 221     /// assert_eq!(buff.remaining_slice(), &[1, 2, 3, 4, 5]);
 222     ///
 223     /// buff.set_position(2);
 224     /// assert_eq!(buff.remaining_slice(), &[3, 4, 5]);
 225     ///
 226     /// buff.set_position(4);
 227     /// assert_eq!(buff.remaining_slice(), &[5]);
 228     ///
 229     /// buff.set_position(6);
 230     /// assert_eq!(buff.remaining_slice(), &[]);
 231     /// ```
 232     #[unstable(feature = "cursor_remaining", issue = "86369")]
 233     pub fn remaining_slice(&self) -> &[u8] {
 234         let len = self.pos.min(self.inner.as_ref().len() as u64);
 235         &self.inner.as_ref()[(len as usize)..]
 236     }
 237
 238     /// Returns `true` if the remaining slice is empty.
 239     ///
 240     /// # Examples
 241     ///
 242     /// ```
 243     /// #![feature(cursor_remaining)]
 244     /// use std::io::Cursor;
 245     ///
 246     /// let mut buff = Cursor::new(vec![1, 2, 3, 4, 5]);
 247     ///
 248     /// buff.set_position(2);
 249     /// assert!(!buff.is_empty());
 250     ///
 251     /// buff.set_position(5);
 252     /// assert!(buff.is_empty());
 253     ///
 254     /// buff.set_position(10);
 255     /// assert!(buff.is_empty());
 256     /// ```
 257     #[unstable(feature = "cursor_remaining", issue = "86369")]
 258     pub fn is_empty(&self) -> bool {
 259         self.pos >= self.inner.as_ref().len() as u64
 260     }
 261 }
 262
 263 #[stable(feature = "rust1", since = "1.0.0")]
 264 impl<T> Clone for Cursor<T>
 265 where
 266     T: Clone,
 267 {
 268     #[inline]
 269     fn clone(&self) -> Self {
 270         Cursor { inner: self.inner.clone(), pos: self.pos }
 271     }
 272
 273     #[inline]
 274     fn clone_from(&mut self, other: &Self) {
 275         self.inner.clone_from(&other.inner);
 276         self.pos = other.pos;
 277     }
 278 }
 279
 280 #[stable(feature = "rust1", since = "1.0.0")]
 281 impl<T> io::Seek for Cursor<T>
 282 where
 283     T: AsRef<[u8]>,
 284 {
 285     fn seek(&mut self, style: SeekFrom) -> io::Result<u64> {
 286         let (base_pos, offset) = match style {
 287             SeekFrom::Start(n) => {
 288                 self.pos = n;
 289                 return Ok(n);
 290             }
 291             SeekFrom::End(n) => (self.inner.as_ref().len() as u64, n),
 292             SeekFrom::Current(n) => (self.pos, n),
 293         };
 294         match base_pos.checked_add_signed(offset) {
 295             Some(n) => {
 296                 self.pos = n;
 297                 Ok(self.pos)
 298             }
 299             None => Err(io::const_io_error!(
 300                 ErrorKind::InvalidInput,
 301                 "invalid seek to a negative or overflowing position",
 302             )),
 303         }
 304     }
 305
 306     fn stream_len(&mut self) -> io::Result<u64> {
 307         Ok(self.inner.as_ref().len() as u64)
 308     }
 309
 310     fn stream_position(&mut self) -> io::Result<u64> {
 311         Ok(self.pos)
 312     }
 313 }
 314
 315 #[stable(feature = "rust1", since = "1.0.0")]
 316 impl<T> Read for Cursor<T>
 317 where
 318     T: AsRef<[u8]>,
 319 {
 320     fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
 321         let n = Read::read(&mut self.remaining_slice(), buf)?;
 322         self.pos += n as u64;
 323         Ok(n)
 324     }
 325
 326     fn read_buf(&mut self, buf: &mut ReadBuf<'_>) -> io::Result<()> {
 327         let prev_filled = buf.filled_len();
 328
 329         Read::read_buf(&mut self.fill_buf()?, buf)?;
 330
 331         self.pos += (buf.filled_len() - prev_filled) as u64;
 332
 333         Ok(())
 334     }
 335
 336     fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> io::Result<usize> {
 337         let mut nread = 0;
 338         for buf in bufs {
 339             let n = self.read(buf)?;
 340             nread += n;
 341             if n < buf.len() {
 342                 break;
 343             }
 344         }
 345         Ok(nread)
 346     }
 347
 348     fn is_read_vectored(&self) -> bool {
 349         true
 350     }
 351
 352     fn read_exact(&mut self, buf: &mut [u8]) -> io::Result<()> {
 353         let n = buf.len();
 354         Read::read_exact(&mut self.remaining_slice(), buf)?;
 355         self.pos += n as u64;
 356         Ok(())
 357     }
 358 }
 359
 360 #[stable(feature = "rust1", since = "1.0.0")]
 361 impl<T> BufRead for Cursor<T>
 362 where
 363     T: AsRef<[u8]>,
 364 {
 365     fn fill_buf(&mut self) -> io::Result<&[u8]> {
 366         Ok(self.remaining_slice())
 367     }
 368     fn consume(&mut self, amt: usize) {
 369         self.pos += amt as u64;
 370     }
 371 }
 372
 373 // Non-resizing write implementation
 374 #[inline]
 375 fn slice_write(pos_mut: &mut u64, slice: &mut [u8], buf: &[u8]) -> io::Result<usize> {
 376     let pos = cmp::min(*pos_mut, slice.len() as u64);
 377     let amt = (&mut slice[(pos as usize)..]).write(buf)?;
 378     *pos_mut += amt as u64;
 379     Ok(amt)
 380 }
 381
 382 #[inline]
 383 fn slice_write_vectored(
 384     pos_mut: &mut u64,
 385     slice: &mut [u8],
 386     bufs: &[IoSlice<'_>],
 387 ) -> io::Result<usize> {
 388     let mut nwritten = 0;
 389     for buf in bufs {
 390         let n = slice_write(pos_mut, slice, buf)?;
 391         nwritten += n;
 392         if n < buf.len() {
 393             break;
 394         }
 395     }
 396     Ok(nwritten)
 397 }
 398
 399 // Resizing write implementation
 400 fn vec_write<A>(pos_mut: &mut u64, vec: &mut Vec<u8, A>, buf: &[u8]) -> io::Result<usize>
 401 where
 402     A: Allocator,
 403 {
 404     let pos: usize = (*pos_mut).try_into().map_err(|_| {
 405         io::const_io_error!(
 406             ErrorKind::InvalidInput,
 407             "cursor position exceeds maximum possible vector length",
 408         )
 409     })?;
 410     // Make sure the internal buffer is as least as big as where we
 411     // currently are
 412     let len = vec.len();
 413     if len < pos {
 414         // use `resize` so that the zero filling is as efficient as possible
 415         vec.resize(pos, 0);
 416     }
 417     // Figure out what bytes will be used to overwrite what's currently
 418     // there (left), and what will be appended on the end (right)
 419     {
 420         let space = vec.len() - pos;
 421         let (left, right) = buf.split_at(cmp::min(space, buf.len()));
 422         vec[pos..pos + left.len()].copy_from_slice(left);
 423         vec.extend_from_slice(right);
 424     }
 425
 426     // Bump us forward
 427     *pos_mut = (pos + buf.len()) as u64;
 428     Ok(buf.len())
 429 }
 430
 431 fn vec_write_vectored<A>(
 432     pos_mut: &mut u64,
 433     vec: &mut Vec<u8, A>,
 434     bufs: &[IoSlice<'_>],
 435 ) -> io::Result<usize>
 436 where
 437     A: Allocator,
 438 {
 439     let mut nwritten = 0;
 440     for buf in bufs {
 441         nwritten += vec_write(pos_mut, vec, buf)?;
 442     }
 443     Ok(nwritten)
 444 }
 445
 446 #[stable(feature = "rust1", since = "1.0.0")]
 447 impl Write for Cursor<&mut [u8]> {
 448     #[inline]
 449     fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
 450         slice_write(&mut self.pos, self.inner, buf)
 451     }
 452
 453     #[inline]
 454     fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> io::Result<usize> {
 455         slice_write_vectored(&mut self.pos, self.inner, bufs)
 456     }
 457
 458     #[inline]
 459     fn is_write_vectored(&self) -> bool {
 460         true
 461     }
 462
 463     #[inline]
 464     fn flush(&mut self) -> io::Result<()> {
 465         Ok(())
 466     }
 467 }
 468
 469 #[stable(feature = "cursor_mut_vec", since = "1.25.0")]
 470 impl<A> Write for Cursor<&mut Vec<u8, A>>
 471 where
 472     A: Allocator,
 473 {
 474     fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
 475         vec_write(&mut self.pos, self.inner, buf)
 476     }
 477
 478     fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> io::Result<usize> {
 479         vec_write_vectored(&mut self.pos, self.inner, bufs)
 480     }
 481
 482     #[inline]
 483     fn is_write_vectored(&self) -> bool {
 484         true
 485     }
 486
 487     #[inline]
 488     fn flush(&mut self) -> io::Result<()> {
 489         Ok(())
 490     }
 491 }
 492
 493 #[stable(feature = "rust1", since = "1.0.0")]
 494 impl<A> Write for Cursor<Vec<u8, A>>
 495 where
 496     A: Allocator,
 497 {
 498     fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
 499         vec_write(&mut self.pos, &mut self.inner, buf)
 500     }
 501
 502     fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> io::Result<usize> {
 503         vec_write_vectored(&mut self.pos, &mut self.inner, bufs)
 504     }
 505
 506     #[inline]
 507     fn is_write_vectored(&self) -> bool {
 508         true
 509     }
 510
 511     #[inline]
 512     fn flush(&mut self) -> io::Result<()> {
 513         Ok(())
 514     }
 515 }
 516
 517 #[stable(feature = "cursor_box_slice", since = "1.5.0")]
 518 impl<A> Write for Cursor<Box<[u8], A>>
 519 where
 520     A: Allocator,
 521 {
 522     #[inline]
 523     fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
 524         slice_write(&mut self.pos, &mut self.inner, buf)
 525     }
 526
 527     #[inline]
 528     fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> io::Result<usize> {
 529         slice_write_vectored(&mut self.pos, &mut self.inner, bufs)
 530     }
 531
 532     #[inline]
 533     fn is_write_vectored(&self) -> bool {
 534         true
 535     }
 536
 537     #[inline]
 538     fn flush(&mut self) -> io::Result<()> {
 539         Ok(())
 540     }
 541 }
 542
 543 #[stable(feature = "cursor_array", since = "1.61.0")]
 544 impl<const N: usize> Write for Cursor<[u8; N]> {
 545     #[inline]
 546     fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
 547         slice_write(&mut self.pos, &mut self.inner, buf)
 548     }
 549
 550     #[inline]
 551     fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> io::Result<usize> {
 552         slice_write_vectored(&mut self.pos, &mut self.inner, bufs)
 553     }
 554
 555     #[inline]
 556     fn is_write_vectored(&self) -> bool {
 557         true
 558     }
 559
 560     #[inline]
 561     fn flush(&mut self) -> io::Result<()> {
 562         Ok(())
 563     }
 564 }