rhai-rand - Package to Generate Random Numbers
rhai-rand is a [Rhai] package to provide random number generation using the [rand] crate.
[Rhai] is an embedded scripting language and evaluation engine for Rust that gives a safe and easy way to add scripting to any application.
Cargo.tomltoml
[dependencies]
rhai-rand = "0.1"
```js // Create random boolean let decision = rand_bool();
if decision {
// Create random number
let random_value = rand();
print(Random number = ${random_value});
} else {
print("Fixed number = 42");
}
// Create array let a = [1, 2, 3, 4, 5];
// Shuffle it! a.shuffle();
// Now the array is shuffled randomly! print(a);
// Sample a random value from the array print(a.sample());
// Or sample multiple values print(a.sample(3)); ```
``rust
// packages::Package implementsassharedmodule`
// which we need to register the RandomPackage
use rhai::{Engine, packages::Package};
use rhai_rand::RandomPackage;
// Create Rhai scripting engine let mut engine = Engine::new();
// Create random number package and add the package into the engine engine.registerglobalmodule(RandomPackage::new().assharedmodule());
// Print 10 random numbers, each of which between 0-99!
for _ in 0..10 {
let value = engine.eval::
println!("Random number = {}", value);
} ```
| Feature | Default | Description |
| :--------: | :------: | ---------------------------------------------------------------------------------- |
| metadata | disabled | includes functions metadata: parameter names/types, return type, doc-comments |
| decimal | Disabled | provides random decimal number generation |
| float | enabled | provides random floating-point number generation |
| array | enabled | provides methods for [Rhai] arrays |
The following functions are defined in this package:
| Function | Return value | Feature | Description |
| :------------------------: | :----------: | :-------: | ---------------------------------------------------------------------- |
| rand() | INT | | generates a random integer number |
| rand(start..end) | INT | | generates a random integer number within an exclusive range |
| rand(start..=end) | INT | | generates a random integer number within an inclusive range |
| rand(start, end) | INT | | generates a random integer number within a range |
| rand_float() | FLOAT | float | generates a random floating-point number between 0.0 and 1.0 |
| rand_float(start, end) | FLOAT | float | generates a random floating-point number an exclusive range |
| rand_decimal() | [Decimal] | decimal | generates a random [decimal][Decimal] number |
| rand_decimal(start, end) | [Decimal] | decimal | generates a random [decimal][Decimal] number within a range |
| rand_bool() | bool | | generates a random boolean |
| rand_bool(p) | bool | | generates a random boolean with the probability p of being true |
| Array.shuffle() | | array | shuffles the items in the [Rhai] array |
| Array.sample() | Dynamic | array | copies a random element from the [Rhai] array |
| Array.sample(n) | Array | array | copies a non-repeating random sample of elements from the [Rhai] array |