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         core::array::from_fn(|_| T::generate_random(rng))
  88     }
  89 }
  90
  91 impl GenerateRandom for String {
  92     fn generate_random<R: rand::Rng + ?Sized>(rng: &mut R) -> Self {
  93         use rand::distributions::{Alphanumeric, DistString};
  94
  95         let len = rng.gen_range(0..32);
  96         Alphanumeric.sample_string(rng, len)
  97     }
  98 }
  99
 100 impl<T: GenerateRandom> GenerateRandom for Vec<T> {
 101     fn generate_random<R: rand::Rng + ?Sized>(rng: &mut R) -> Self {
 102         let len = rng.gen_range(0..8);
 103         (0..len).map(|_| T::generate_random(rng)).collect()
 104     }
 105 }
 106
 107 impl<K, V> GenerateRandom for std::collections::HashMap<K, V>
 108 where
 109     K: GenerateRandom + std::cmp::Eq + std::hash::Hash,
 110     V: GenerateRandom,
 111 {
 112     fn generate_random<R: rand::Rng + ?Sized>(rng: &mut R) -> Self {
 113         let len = rng.gen_range(0..8);
 114         (0..len)
 115             .map(|_| (K::generate_random(rng), V::generate_random(rng)))
 116             .collect()
 117     }
 118 }
 119
 120 impl<T: GenerateRandom> GenerateRandom for Box<T> {
 121     fn generate_random<R: rand::Rng + ?Sized>(rng: &mut R) -> Self {
 122         Box::new(T::generate_random(rng))
 123     }
 124 }
 125
 126 #[cfg(feature = "enumset")]
 127 impl<T: enumset::EnumSetType + GenerateRandom> GenerateRandom for enumset::EnumSet<T> {
 128     fn generate_random<R: rand::Rng + ?Sized>(rng: &mut R) -> Self {
 129         let max = enumset::EnumSet::<T>::variant_count() * 2;
 130         let len = rng.gen_range(0..max);
 131
 132         (0..len).map(|_| T::generate_random(rng)).collect()
 133     }
 134 }
 135
 136 macro_rules! impl_generate_random_tuple {
 137         ( $t0:ident $( $t:ident )* ) => {
 138                 impl< $t0, $( $t, )* > GenerateRandom for ( $t0, $( $t, )* )
 139                 where
 140                         $t0: GenerateRandom,
 141                         $(
 142                                 $t: GenerateRandom,
 143                         )*
 144                 {
 145                         fn generate_random<R: rand::Rng + ?Sized>(rng: &mut R) -> Self {
 146                                 (
 147                                         $t0::generate_random(rng),
 148                                         $(
 149                                                 $t::generate_random(rng),
 150                                         )*
 151                                 )
 152                         }
 153                 }
 154                 impl_generate_random_tuple!( $( $t )* );
 155         };
 156         () => {
 157                 impl GenerateRandom for () {
 158                         fn generate_random<R: rand::Rng + ?Sized>(_rng: &mut R) -> Self {
 159                                 ()
 160                         }
 161                 }
 162         }
 163 }
 164
 165 impl_generate_random_tuple!(A B C D E F G H I J K L);
 166
 167 #[cfg(test)]
 168 mod tests {
 169     use super::*;
 170
 171     fn rng() -> impl rand::Rng {
 172         use rand::SeedableRng;
 173         rand_chacha::ChaCha8Rng::from(rand_chacha::ChaCha8Core::from_seed([37; 32]))
 174     }
 175
 176     #[test]
 177     fn test_u8() {
 178         let mut rng = rng();
 179         assert_eq!(u8::generate_random(&mut rng), 55);
 180     }
 181 }