1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
//! Interpreter global psuedorandom number generator.

/// Interpreter global psuedorandom number generator.
///
/// Implementors of this trait back the `Random::DEFAULT` PRNG.
pub trait Prng {
    /// Concrete type for PRNG errors.
    type Error;

    /// Conrete type for the interpreter psuedorandom number generator.
    type Prng;

    /// Return a shared reference to the interpreter psuedorandom number
    /// generator.
    ///
    /// # Errors
    ///
    /// If the PRNG is inaccessible, an error is returned.
    fn prng(&self) -> Result<&Self::Prng, Self::Error>;

    /// Return a mutable reference to the interpreter psuedorandom number
    /// generator.
    ///
    /// # Errors
    ///
    /// If the PRNG is inaccessible, an error is returned.
    fn prng_mut(&mut self) -> Result<&mut Self::Prng, Self::Error>;
}