src/libstd/rand/reader.rs

   1 // Copyright 2013 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 //! A wrapper around any Reader to treat it as an RNG.
  12
  13 use io::Reader;
  14 use rand::Rng;
  15 use result::{Ok, Err};
  16 use slice::SlicePrelude;
  17
  18 /// An RNG that reads random bytes straight from a `Reader`. This will
  19 /// work best with an infinite reader, but this is not required.
  20 ///
  21 /// # Panics
  22 ///
  23 /// It will panic if it there is insufficient data to fulfill a request.
  24 ///
  25 /// # Example
  26 ///
  27 /// ```rust
  28 /// use std::rand::{reader, Rng};
  29 /// use std::io::MemReader;
  30 ///
  31 /// let mut rng = reader::ReaderRng::new(MemReader::new(vec!(1,2,3,4,5,6,7,8)));
  32 /// println!("{:x}", rng.gen::<uint>());
  33 /// ```
  34 pub struct ReaderRng<R> {
  35     reader: R
  36 }
  37
  38 impl<R: Reader> ReaderRng<R> {
  39     /// Create a new `ReaderRng` from a `Reader`.
  40     pub fn new(r: R) -> ReaderRng<R> {
  41         ReaderRng {
  42             reader: r
  43         }
  44     }
  45 }
  46
  47 impl<R: Reader> Rng for ReaderRng<R> {
  48     fn next_u32(&mut self) -> u32 {
  49         // This is designed for speed: reading a LE integer on a LE
  50         // platform just involves blitting the bytes into the memory
  51         // of the u32, similarly for BE on BE; avoiding byteswapping.
  52         if cfg!(target_endian="little") {
  53             self.reader.read_le_u32().unwrap()
  54         } else {
  55             self.reader.read_be_u32().unwrap()
  56         }
  57     }
  58     fn next_u64(&mut self) -> u64 {
  59         // see above for explanation.
  60         if cfg!(target_endian="little") {
  61             self.reader.read_le_u64().unwrap()
  62         } else {
  63             self.reader.read_be_u64().unwrap()
  64         }
  65     }
  66     fn fill_bytes(&mut self, v: &mut [u8]) {
  67         if v.len() == 0 { return }
  68         match self.reader.read_at_least(v.len(), v) {
  69             Ok(_) => {}
  70             Err(e) => panic!("ReaderRng.fill_bytes error: {}", e)
  71         }
  72     }
  73 }
  74
  75 #[cfg(test)]
  76 mod test {
  77     use prelude::*;
  78
  79     use super::ReaderRng;
  80     use io::MemReader;
  81     use num::Int;
  82     use rand::Rng;
  83
  84     #[test]
  85     fn test_reader_rng_u64() {
  86         // transmute from the target to avoid endianness concerns.
  87         let v = vec![0u8, 0, 0, 0, 0, 0, 0, 1,
  88                      0  , 0, 0, 0, 0, 0, 0, 2,
  89                      0,   0, 0, 0, 0, 0, 0, 3];
  90         let mut rng = ReaderRng::new(MemReader::new(v));
  91
  92         assert_eq!(rng.next_u64(), 1_u64.to_be());
  93         assert_eq!(rng.next_u64(), 2_u64.to_be());
  94         assert_eq!(rng.next_u64(), 3_u64.to_be());
  95     }
  96     #[test]
  97     fn test_reader_rng_u32() {
  98         let v = vec![0u8, 0, 0, 1, 0, 0, 0, 2, 0, 0, 0, 3];
  99         let mut rng = ReaderRng::new(MemReader::new(v));
 100
 101         assert_eq!(rng.next_u32(), 1_u32.to_be());
 102         assert_eq!(rng.next_u32(), 2_u32.to_be());
 103         assert_eq!(rng.next_u32(), 3_u32.to_be());
 104     }
 105     #[test]
 106     fn test_reader_rng_fill_bytes() {
 107         let v = [1u8, 2, 3, 4, 5, 6, 7, 8];
 108         let mut w = [0u8, .. 8];
 109
 110         let mut rng = ReaderRng::new(MemReader::new(v.as_slice().to_vec()));
 111         rng.fill_bytes(&mut w);
 112
 113         assert!(v == w);
 114     }
 115
 116     #[test]
 117     #[should_fail]
 118     fn test_reader_rng_insufficient_bytes() {
 119         let mut rng = ReaderRng::new(MemReader::new(vec!()));
 120         let mut v = [0u8, .. 3];
 121         rng.fill_bytes(&mut v);
 122     }
 123 }