bevy_prng 0.14.2

A crate providing newtyped RNGs for integration into Bevy.
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
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

#![doc = include_str!("../README.md")]
#![deny(missing_docs)]
#![cfg_attr(docsrs, feature(doc_cfg))]
#![cfg_attr(docsrs, allow(unused_attributes))]
#![no_std]

extern crate alloc;

#[cfg(feature = "std")]
extern crate std;

#[cfg(feature = "chacha20")]
mod chacha;
#[cfg(any(
    feature = "wyrand",
    feature = "chacha20",
    feature = "rand_pcg",
    feature = "rand_xoshiro"
))]
mod newtype;
#[cfg(feature = "rand_pcg")]
mod pcg;
#[cfg(feature = "wyrand")]
mod wyrand;
#[cfg(feature = "rand_xoshiro")]
mod xoshiro;
mod utils;

#[cfg(feature = "thread_local_entropy")]
mod thread_local_entropy;

use core::fmt::Debug;

use bevy_ecs::component::{Component, Mutable};
#[cfg(feature = "bevy_reflect")]
use bevy_reflect::{FromReflect, Reflectable, Typed};
use rand_core::{Rng, SeedableRng};

#[cfg(feature = "chacha20")]
pub use chacha::*;
#[cfg(feature = "rand_pcg")]
pub use pcg::*;
#[cfg(feature = "thread_local_entropy")]
pub use thread_local_entropy::ThreadLocalEntropy;
#[cfg(feature = "wyrand")]
pub use wyrand::WyRand;
#[cfg(feature = "rand_xoshiro")]
pub use xoshiro::*;

/// Trait for handling `SeedableRng` requirements, imposing constraints
/// depending on whether reflection support is enabled or not
#[cfg(feature = "bevy_reflect")]
pub trait TypedSeed: SeedableRng<Seed: Typed + Debug + Send + Sync + Clone> {}

#[cfg(feature = "bevy_reflect")]
impl<T: SeedableRng<Seed: Typed + Debug + Send + Sync + Clone>> TypedSeed for T {}

/// Trait for handling `SeedableRng` requirements, imposing constraints
/// depending on whether reflection support is enabled or not
#[cfg(not(feature = "bevy_reflect"))]
pub trait TypedSeed: SeedableRng<Seed: Debug + Send + Sync + Clone> {}

#[cfg(not(feature = "bevy_reflect"))]
impl<T: SeedableRng<Seed: Debug + Send + Sync + Clone>> TypedSeed for T {}

/// Trait for handling contraints for valid implementations of [`EntropySource`]
/// depending on whether reflection support is enabled or not
#[cfg(feature = "bevy_reflect")]
pub trait RngReflectable: FromReflect + Reflectable {}

#[cfg(feature = "bevy_reflect")]
impl<T: FromReflect + Reflectable> RngReflectable for T {}

/// Trait for handling contraints for valid implementations of [`EntropySource`]
/// depending on whether reflection support is enabled or not
#[cfg(not(feature = "bevy_reflect"))]
pub trait RngReflectable: 'static {}

#[cfg(not(feature = "bevy_reflect"))]
impl<T: 'static> RngReflectable for T {}

/// A marker trait to define the required trait bounds for a seedable PRNG to be
/// integrated as a component. This is a sealed trait.
pub trait EntropySource:
    Rng
    + RngReflectable
    + TypedSeed
    + Clone
    + Debug
    + PartialEq
    + Component<Mutability = Mutable>
    + Sync
    + Send
    + RemoteRng
    + private::SealedSeedable
{
}

/// Marker trait for a suitable seed for [`EntropySource`]. This is an auto trait which will
/// apply to all suitable types that meet the trait criteria.
pub trait EntropySeed:
    Debug + Default + PartialEq + AsMut<[u8]> + Clone + Sync + Send + RngReflectable
{
}

impl<T: Debug + Default + PartialEq + AsMut<[u8]> + Clone + Sync + Send + RngReflectable>
    EntropySeed for T
{
}

/// Reflectable Rng. This trait ensures that if `bevy_reflect` is active,
/// that all [`EntropySource`] PRNGs can be used through reflection and interface
/// with [`Rng`].
#[cfg_attr(feature = "bevy_reflect", bevy_reflect::reflect_trait)]
pub trait RemoteRng: Rng {}

mod private {
    pub trait SealedSeedable {}

    impl<T: super::EntropySource> SealedSeedable for T {}
}