src/librustc/util/io.rs

   1 // Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 use std::io::{IoError, IoResult, SeekStyle};
  12 use std::io;
  13 use std::slice;
  14
  15 static BUF_CAPACITY: uint = 128;
  16
  17 fn combine(seek: SeekStyle, cur: uint, end: uint, offset: i64) -> IoResult<u64> {
  18     // compute offset as signed and clamp to prevent overflow
  19     let pos = match seek {
  20         io::SeekSet => 0,
  21         io::SeekEnd => end,
  22         io::SeekCur => cur,
  23     } as i64;
  24
  25     if offset + pos < 0 {
  26         Err(IoError {
  27             kind: io::InvalidInput,
  28             desc: "invalid seek to a negative offset",
  29             detail: None
  30         })
  31     } else {
  32         Ok((offset + pos) as u64)
  33     }
  34 }
  35
  36 /// Writes to an owned, growable byte vector that supports seeking.
  37 ///
  38 /// # Example
  39 ///
  40 /// ```rust
  41 /// # #![allow(unused_must_use)]
  42 /// use std::io::SeekableMemWriter;
  43 ///
  44 /// let mut w = SeekableMemWriter::new();
  45 /// w.write([0, 1, 2]);
  46 ///
  47 /// assert_eq!(w.unwrap(), vec!(0, 1, 2));
  48 /// ```
  49 pub struct SeekableMemWriter {
  50     buf: Vec<u8>,
  51     pos: uint,
  52 }
  53
  54 impl SeekableMemWriter {
  55     /// Create a new `SeekableMemWriter`.
  56     #[inline]
  57     pub fn new() -> SeekableMemWriter {
  58         SeekableMemWriter::with_capacity(BUF_CAPACITY)
  59     }
  60     /// Create a new `SeekableMemWriter`, allocating at least `n` bytes for
  61     /// the internal buffer.
  62     #[inline]
  63     pub fn with_capacity(n: uint) -> SeekableMemWriter {
  64         SeekableMemWriter { buf: Vec::with_capacity(n), pos: 0 }
  65     }
  66
  67     /// Acquires an immutable reference to the underlying buffer of this
  68     /// `SeekableMemWriter`.
  69     ///
  70     /// No method is exposed for acquiring a mutable reference to the buffer
  71     /// because it could corrupt the state of this `MemWriter`.
  72     #[inline]
  73     pub fn get_ref<'a>(&'a self) -> &'a [u8] { self.buf.as_slice() }
  74
  75     /// Unwraps this `SeekableMemWriter`, returning the underlying buffer
  76     #[inline]
  77     pub fn unwrap(self) -> Vec<u8> { self.buf }
  78 }
  79
  80 impl Writer for SeekableMemWriter {
  81     #[inline]
  82     fn write(&mut self, buf: &[u8]) -> IoResult<()> {
  83         if self.pos == self.buf.len() {
  84             self.buf.push_all(buf)
  85         } else {
  86             // Make sure the internal buffer is as least as big as where we
  87             // currently are
  88             let difference = self.pos as i64 - self.buf.len() as i64;
  89             if difference > 0 {
  90                 self.buf.grow(difference as uint, &0);
  91             }
  92
  93             // Figure out what bytes will be used to overwrite what's currently
  94             // there (left), and what will be appended on the end (right)
  95             let cap = self.buf.len() - self.pos;
  96             let (left, right) = if cap <= buf.len() {
  97                 (buf.slice_to(cap), buf.slice_from(cap))
  98             } else {
  99                 (buf, &[])
 100             };
 101
 102             // Do the necessary writes
 103             if left.len() > 0 {
 104                 slice::bytes::copy_memory(self.buf.mut_slice_from(self.pos), left);
 105             }
 106             if right.len() > 0 {
 107                 self.buf.push_all(right);
 108             }
 109         }
 110
 111         // Bump us forward
 112         self.pos += buf.len();
 113         Ok(())
 114     }
 115 }
 116
 117 impl Seek for SeekableMemWriter {
 118     #[inline]
 119     fn tell(&self) -> IoResult<u64> { Ok(self.pos as u64) }
 120
 121     #[inline]
 122     fn seek(&mut self, pos: i64, style: SeekStyle) -> IoResult<()> {
 123         let new = try!(combine(style, self.pos, self.buf.len(), pos));
 124         self.pos = new as uint;
 125         Ok(())
 126     }
 127 }
 128
 129 #[cfg(test)]
 130 mod tests {
 131     use super::SeekableMemWriter;
 132     use std::io;
 133     use test::Bencher;
 134
 135     #[test]
 136     fn test_seekable_mem_writer() {
 137         let mut writer = SeekableMemWriter::new();
 138         assert_eq!(writer.tell(), Ok(0));
 139         writer.write([0]).unwrap();
 140         assert_eq!(writer.tell(), Ok(1));
 141         writer.write([1, 2, 3]).unwrap();
 142         writer.write([4, 5, 6, 7]).unwrap();
 143         assert_eq!(writer.tell(), Ok(8));
 144         assert_eq!(writer.get_ref(), &[0, 1, 2, 3, 4, 5, 6, 7]);
 145
 146         writer.seek(0, io::SeekSet).unwrap();
 147         assert_eq!(writer.tell(), Ok(0));
 148         writer.write([3, 4]).unwrap();
 149         assert_eq!(writer.get_ref(), &[3, 4, 2, 3, 4, 5, 6, 7]);
 150
 151         writer.seek(1, io::SeekCur).unwrap();
 152         writer.write([0, 1]).unwrap();
 153         assert_eq!(writer.get_ref(), &[3, 4, 2, 0, 1, 5, 6, 7]);
 154
 155         writer.seek(-1, io::SeekEnd).unwrap();
 156         writer.write([1, 2]).unwrap();
 157         assert_eq!(writer.get_ref(), &[3, 4, 2, 0, 1, 5, 6, 1, 2]);
 158
 159         writer.seek(1, io::SeekEnd).unwrap();
 160         writer.write([1]).unwrap();
 161         assert_eq!(writer.get_ref(), &[3, 4, 2, 0, 1, 5, 6, 1, 2, 0, 1]);
 162     }
 163
 164     #[test]
 165     fn seek_past_end() {
 166         let mut r = SeekableMemWriter::new();
 167         r.seek(10, io::SeekSet).unwrap();
 168         assert!(r.write([3]).is_ok());
 169     }
 170
 171     #[test]
 172     fn seek_before_0() {
 173         let mut r = SeekableMemWriter::new();
 174         assert!(r.seek(-1, io::SeekSet).is_err());
 175     }
 176
 177     fn do_bench_seekable_mem_writer(b: &mut Bencher, times: uint, len: uint) {
 178         let src: Vec<u8> = Vec::from_elem(len, 5);
 179
 180         b.bytes = (times * len) as u64;
 181         b.iter(|| {
 182             let mut wr = SeekableMemWriter::new();
 183             for _ in range(0, times) {
 184                 wr.write(src.as_slice()).unwrap();
 185             }
 186
 187             let v = wr.unwrap();
 188             assert_eq!(v.len(), times * len);
 189             assert!(v.iter().all(|x| *x == 5));
 190         });
 191     }
 192
 193     #[bench]
 194     fn bench_seekable_mem_writer_001_0000(b: &mut Bencher) {
 195         do_bench_seekable_mem_writer(b, 1, 0)
 196     }
 197
 198     #[bench]
 199     fn bench_seekable_mem_writer_001_0010(b: &mut Bencher) {
 200         do_bench_seekable_mem_writer(b, 1, 10)
 201     }
 202
 203     #[bench]
 204     fn bench_seekable_mem_writer_001_0100(b: &mut Bencher) {
 205         do_bench_seekable_mem_writer(b, 1, 100)
 206     }
 207
 208     #[bench]
 209     fn bench_seekable_mem_writer_001_1000(b: &mut Bencher) {
 210         do_bench_seekable_mem_writer(b, 1, 1000)
 211     }
 212
 213     #[bench]
 214     fn bench_seekable_mem_writer_100_0000(b: &mut Bencher) {
 215         do_bench_seekable_mem_writer(b, 100, 0)
 216     }
 217
 218     #[bench]
 219     fn bench_seekable_mem_writer_100_0010(b: &mut Bencher) {
 220         do_bench_seekable_mem_writer(b, 100, 10)
 221     }
 222
 223     #[bench]
 224     fn bench_seekable_mem_writer_100_0100(b: &mut Bencher) {
 225         do_bench_seekable_mem_writer(b, 100, 100)
 226     }
 227
 228     #[bench]
 229     fn bench_seekable_mem_writer_100_1000(b: &mut Bencher) {
 230         do_bench_seekable_mem_writer(b, 100, 1000)
 231     }
 232 }