artichoke_core/
prng.rs

1//! Interpreter global pseudorandom number generator.
2
3/// Interpreter global pseudorandom number generator (PRNG).
4///
5/// Implementations of this trait may be used as the backing pseudorandom number
6/// generator for [`Random::DEFAULT`].
7///
8/// The PRNG used to implement this trait is **not** required to be
9/// cryptographically secure. For example, MRI's PRNG is a variant of Mersenne
10/// Twister.
11///
12/// [`Random::DEFAULT`]: https://ruby-doc.org/core-3.1.2/Random.html#DEFAULT
13pub trait Prng {
14    /// Concrete type for errors when retrieving the pseudorandom number
15    /// generator.
16    type Error;
17
18    /// Concrete type for the interpreter pseudorandom number generator.
19    type Prng;
20
21    /// Return a shared reference to the interpreter pseudorandom number
22    /// generator.
23    ///
24    /// # Errors
25    ///
26    /// If the PRNG is inaccessible, an error is returned.
27    fn prng(&self) -> Result<&Self::Prng, Self::Error>;
28
29    /// Return a mutable reference to the interpreter pseudorandom number
30    /// generator.
31    ///
32    /// # Errors
33    ///
34    /// If the PRNG is inaccessible, an error is returned.
35    fn prng_mut(&mut self) -> Result<&mut Self::Prng, Self::Error>;
36}
artichoke_core/prng.rs

artichoke_core/
prng.rs
