lib/src/lib.rs

   1 //! Generate random data.
   2 //!
   3 //! # Examples
   4 //!
   5 //! ```
   6 //! use generate_random::GenerateRandom;
   7 //!
   8 //! #[derive(GenerateRandom)]
   9 //! enum MyEnum {
  10 //!     A,
  11 //!     C(bool),
  12 //!     B {
  13 //!         x: u8,
  14 //!     },
  15 //!     // Providing a weight allows changing the probabilities.
  16 //!     // This variant is now twice as likely to be generated as the others.
  17 //!     #[weight(2)]
  18 //!     D,
  19 //! }
  20 //!
  21 //! let mut rng = rand::thread_rng();
  22 //! let my_value = MyEnum::generate_random(&mut rng);
  23 //! ```
  24
  25 /// This derive macro provides an implementation
  26 /// of the [`trait@GenerateRandom`] trait.
  27 ///
  28 /// Enum variants can be given a `weight` attribute
  29 /// to change how often it is generated.
  30 /// By default, the weight is `1`.
  31 /// The probability of a variants is its weight
  32 /// divided by the sum over all variants.
  33 pub use generate_random_macro::GenerateRandom;
  34
  35 /// Enable randomly generating values of a type.
  36 ///
  37 /// This trait can be implemented using the derive
  38 /// macro of the same name: [`macro@GenerateRandom`].
  39 pub trait GenerateRandom {
  40     /// Create a new random value of this type.
  41     fn generate_random<R: rand::Rng + ?Sized>(rng: &mut R) -> Self;
  42 }
  43
  44 macro_rules! impl_generate_random {
  45         ( $( $t:ty, )+ ) => {
  46                 $(
  47                         impl GenerateRandom for $t {
  48                                 fn generate_random<R: rand::Rng + ?Sized>(rng: &mut R) -> Self {
  49                                         rng.gen()
  50                                 }
  51                         }
  52                 )+
  53         }
  54 }
  55
  56 impl_generate_random! {
  57     bool,
  58     char,
  59     u8,
  60     i8,
  61     u16,
  62     i16,
  63     u32,
  64     i32,
  65     u64,
  66     i64,
  67     u128,
  68     i128,
  69     usize,
  70     isize,
  71     f32,
  72     f64,
  73 }
  74
  75 impl<T: GenerateRandom> GenerateRandom for Option<T> {
  76     fn generate_random<R: rand::Rng + ?Sized>(rng: &mut R) -> Self {
  77         if bool::generate_random(rng) {
  78             Some(T::generate_random(rng))
  79         } else {
  80             None
  81         }
  82     }
  83 }
  84
  85 impl<T: GenerateRandom, const N: usize> GenerateRandom for [T; N] {
  86     fn generate_random<R: rand::Rng + ?Sized>(rng: &mut R) -> Self {
  87         use core::mem::MaybeUninit;
  88
  89         let mut arr: [MaybeUninit<T>; N] = unsafe { MaybeUninit::uninit().assume_init() };
  90
  91         for elem in arr.iter_mut() {
  92             *elem = MaybeUninit::new(T::generate_random(rng));
  93         }
  94
  95         let ret = unsafe { std::mem::transmute_copy(&arr) };
  96         std::mem::forget(arr);
  97
  98         ret
  99     }
 100 }
 101
 102 impl GenerateRandom for String {
 103     fn generate_random<R: rand::Rng + ?Sized>(rng: &mut R) -> Self {
 104         use rand::distributions::{Alphanumeric, DistString};
 105
 106         let len = rng.gen_range(0..32);
 107         Alphanumeric.sample_string(rng, len)
 108     }
 109 }
 110
 111 macro_rules! impl_generate_random_tuple {
 112         ( $t0:ident $( $t:ident )* ) => {
 113                 impl< $t0, $( $t, )* > GenerateRandom for ( $t0, $( $t, )* )
 114                 where
 115                         $t0: GenerateRandom,
 116                         $(
 117                                 $t: GenerateRandom,
 118                         )*
 119                 {
 120                         fn generate_random<R: rand::Rng + ?Sized>(rng: &mut R) -> Self {
 121                                 (
 122                                         $t0::generate_random(rng),
 123                                         $(
 124                                                 $t::generate_random(rng),
 125                                         )*
 126                                 )
 127                         }
 128                 }
 129                 impl_generate_random_tuple!( $( $t )* );
 130         };
 131         () => {
 132                 impl GenerateRandom for () {
 133                         fn generate_random<R: rand::Rng + ?Sized>(_rng: &mut R) -> Self {
 134                                 ()
 135                         }
 136                 }
 137         }
 138 }
 139
 140 impl_generate_random_tuple!(A B C D E F G H I J K L);
 141
 142 #[cfg(test)]
 143 mod tests {
 144     use super::*;
 145
 146     fn rng() -> impl rand::Rng {
 147         use rand::SeedableRng;
 148         rand_chacha::ChaCha8Rng::from(rand_chacha::ChaCha8Core::from_seed([37; 32]))
 149     }
 150
 151     #[test]
 152     fn test_u8() {
 153         let mut rng = rng();
 154         assert_eq!(u8::generate_random(&mut rng), 55);
 155     }
 156 }