Struct bones_framework::networking::random::RngGenerator
source · pub struct RngGenerator { /* private fields */ }
Expand description
Resource that produces deterministic pseudo-random numbers/strings.
Access in a system with Res<RngGenerator>
.
Implementations§
source§impl RngGenerator
impl RngGenerator
sourcepub fn new(seed: u64) -> Self
pub fn new(seed: u64) -> Self
Creates a new RngGenerator
, initializing it with the provided seed
sourcepub fn gen_u8_range<R: RangeBounds<u8>>(&mut self, range: R) -> u8
pub fn gen_u8_range<R: RangeBounds<u8>>(&mut self, range: R) -> u8
Generate a random u8 within the given range
sourcepub fn gen_i8_range<R: RangeBounds<i8>>(&mut self, range: R) -> i8
pub fn gen_i8_range<R: RangeBounds<i8>>(&mut self, range: R) -> i8
Generate a random i8 within the given range
sourcepub fn gen_u16_range<R: RangeBounds<u16>>(&mut self, range: R) -> u16
pub fn gen_u16_range<R: RangeBounds<u16>>(&mut self, range: R) -> u16
Generate a random u16 within the given range
sourcepub fn gen_i16_range<R: RangeBounds<i16>>(&mut self, range: R) -> i16
pub fn gen_i16_range<R: RangeBounds<i16>>(&mut self, range: R) -> i16
Generate a random i16 within the given range
sourcepub fn gen_u32_range<R: RangeBounds<u32>>(&mut self, range: R) -> u32
pub fn gen_u32_range<R: RangeBounds<u32>>(&mut self, range: R) -> u32
Generate a random u32 within the given range
sourcepub fn gen_i32_range<R: RangeBounds<i32>>(&mut self, range: R) -> i32
pub fn gen_i32_range<R: RangeBounds<i32>>(&mut self, range: R) -> i32
Generate a random i32 within the given range
sourcepub fn gen_u64_range<R: RangeBounds<u64>>(&mut self, range: R) -> u64
pub fn gen_u64_range<R: RangeBounds<u64>>(&mut self, range: R) -> u64
Generate a random u64 within the given range
sourcepub fn gen_i64_range<R: RangeBounds<i64>>(&mut self, range: R) -> i64
pub fn gen_i64_range<R: RangeBounds<i64>>(&mut self, range: R) -> i64
Generate a random i64 within the given range
sourcepub fn gen_usize_range<R: RangeBounds<usize>>(&mut self, range: R) -> usize
pub fn gen_usize_range<R: RangeBounds<usize>>(&mut self, range: R) -> usize
Generate a random usize within the given range
sourcepub fn gen_isize_range<R: RangeBounds<isize>>(&mut self, range: R) -> isize
pub fn gen_isize_range<R: RangeBounds<isize>>(&mut self, range: R) -> isize
Generate a random isize within the given range
sourcepub fn gen_f32_range<R: RangeBounds<f32>>(&mut self, range: R) -> f32
pub fn gen_f32_range<R: RangeBounds<f32>>(&mut self, range: R) -> f32
Generate a random f32 within the given range
sourcepub fn gen_f64_range<R: RangeBounds<f64>>(&mut self, range: R) -> f64
pub fn gen_f64_range<R: RangeBounds<f64>>(&mut self, range: R) -> f64
Generate a random f64 within the given range
sourcepub fn gen_vec2_range<R1: RangeBounds<f32>, R2: RangeBounds<f32>>(
&mut self,
x_range: R1,
y_range: R2,
) -> Vec2
pub fn gen_vec2_range<R1: RangeBounds<f32>, R2: RangeBounds<f32>>( &mut self, x_range: R1, y_range: R2, ) -> Vec2
Generate a random Vec2 within the given ranges for each component
sourcepub fn gen_vec3_range<R1: RangeBounds<f32>, R2: RangeBounds<f32>, R3: RangeBounds<f32>>(
&mut self,
x_range: R1,
y_range: R2,
z_range: R3,
) -> Vec3
pub fn gen_vec3_range<R1: RangeBounds<f32>, R2: RangeBounds<f32>, R3: RangeBounds<f32>>( &mut self, x_range: R1, y_range: R2, z_range: R3, ) -> Vec3
Generate a random Vec3 within the given ranges for each component
sourcepub fn shuffle_vec<T>(&mut self, vec: &mut [T])
pub fn shuffle_vec<T>(&mut self, vec: &mut [T])
Shuffle a Vec in place
sourcepub fn shuffle_svec<T: HasSchema>(&mut self, svec: &mut SVec<T>)
pub fn shuffle_svec<T: HasSchema>(&mut self, svec: &mut SVec<T>)
Shuffle an SVec in place
sourcepub fn shuffle_vecdeque<T>(&mut self, deque: &mut VecDeque<T>)
pub fn shuffle_vecdeque<T>(&mut self, deque: &mut VecDeque<T>)
Shuffle a VecDeque in place
sourcepub fn gen_alphabetic(&mut self) -> char
pub fn gen_alphabetic(&mut self) -> char
Generates a random char
in ranges a-z and A-Z.
sourcepub fn gen_alphanumeric(&mut self) -> char
pub fn gen_alphanumeric(&mut self) -> char
Generates a random char
in ranges a-z, A-Z and 0-9.
sourcepub fn gen_lowercase(&mut self) -> char
pub fn gen_lowercase(&mut self) -> char
Generates a random char
in the range a-z.
sourcepub fn gen_uppercase(&mut self) -> char
pub fn gen_uppercase(&mut self) -> char
Generates a random char
in the range A-Z.
sourcepub fn gen_digit(&mut self, radix: u8) -> char
pub fn gen_digit(&mut self, radix: u8) -> char
Generate a random digit in the given radix
.
Digits are represented by char
s in ranges 0-9 and a-z.
§Panics
Panics if the radix
is zero or greater than 36.
sourcepub fn gen_char<R: RangeBounds<char>>(&mut self, bounds: R) -> char
pub fn gen_char<R: RangeBounds<char>>(&mut self, bounds: R) -> char
sourcepub fn gen_random_ascii_char(&mut self) -> char
pub fn gen_random_ascii_char(&mut self) -> char
Generate a random printable ASCII character
sourcepub fn gen_random_ascii_string(&mut self, length: u64) -> String
pub fn gen_random_ascii_string(&mut self, length: u64) -> String
Generate a random ASCII string of the specified length
sourcepub fn gen_chance(&mut self, success_rate: f64) -> bool
pub fn gen_chance(&mut self, success_rate: f64) -> bool
Returns a boolean, where success_rate
represents the chance to return a true value,
with 0.0 being no chance and 1.0 will always return true.
sourcepub fn gen_sample<'a, T>(&mut self, list: &'a [T]) -> Option<&'a T>
pub fn gen_sample<'a, T>(&mut self, list: &'a [T]) -> Option<&'a T>
Samples a random item from a slice of values.
sourcepub fn gen_sample_iter<T: Iterator>(&mut self, list: T) -> Option<T::Item>
pub fn gen_sample_iter<T: Iterator>(&mut self, list: T) -> Option<T::Item>
Samples a random item from an iterator of values.
sourcepub fn gen_sample_mut<'a, T>(&mut self, list: &'a mut [T]) -> Option<&'a mut T>
pub fn gen_sample_mut<'a, T>(&mut self, list: &'a mut [T]) -> Option<&'a mut T>
Samples a random &mut item from a slice of values.
sourcepub fn gen_sample_multiple<'a, T>(
&mut self,
list: &'a [T],
amount: usize,
) -> Vec<&'a T>
pub fn gen_sample_multiple<'a, T>( &mut self, list: &'a [T], amount: usize, ) -> Vec<&'a T>
Samples multiple unique items from a slice of values.
sourcepub fn gen_sample_multiple_mut<'a, T>(
&mut self,
list: &'a mut [T],
amount: usize,
) -> Vec<&'a mut T>
pub fn gen_sample_multiple_mut<'a, T>( &mut self, list: &'a mut [T], amount: usize, ) -> Vec<&'a mut T>
Samples multiple unique items from a mutable slice of values.
sourcepub fn gen_sample_multiple_iter<T: Iterator>(
&mut self,
list: T,
amount: usize,
) -> Vec<T::Item>
pub fn gen_sample_multiple_iter<T: Iterator>( &mut self, list: T, amount: usize, ) -> Vec<T::Item>
Samples multiple unique items from an iterator of values.
sourcepub fn gen_weighted_sample<'a, T, F>(
&mut self,
list: &'a [T],
weight_sampler: F,
) -> Option<&'a T>
pub fn gen_weighted_sample<'a, T, F>( &mut self, list: &'a [T], weight_sampler: F, ) -> Option<&'a T>
Stochastic Acceptance implementation of Roulette Wheel weighted selection.
Trait Implementations§
source§impl Clone for RngGenerator
impl Clone for RngGenerator
source§fn clone(&self) -> RngGenerator
fn clone(&self) -> RngGenerator
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Default for RngGenerator
impl Default for RngGenerator
source§impl HasSchema for RngGenerator
impl HasSchema for RngGenerator
source§fn register_schema()
fn register_schema()
source§fn cast<T>(this: &Self) -> &Twhere
T: HasSchema,
fn cast<T>(this: &Self) -> &Twhere
T: HasSchema,
source§fn try_cast<T>(this: &Self) -> Result<&T, SchemaMismatchError>where
T: HasSchema,
fn try_cast<T>(this: &Self) -> Result<&T, SchemaMismatchError>where
T: HasSchema,
source§fn cast_mut<T>(this: &mut Self) -> &mut Twhere
T: HasSchema,
fn cast_mut<T>(this: &mut Self) -> &mut Twhere
T: HasSchema,
source§fn try_cast_mut<T>(this: &mut Self) -> Result<&mut T, SchemaMismatchError>where
T: HasSchema,
fn try_cast_mut<T>(this: &mut Self) -> Result<&mut T, SchemaMismatchError>where
T: HasSchema,
source§fn as_schema_ref(&self) -> SchemaRef<'_>where
Self: Sized,
fn as_schema_ref(&self) -> SchemaRef<'_>where
Self: Sized,
T
to a SchemaRef
source§fn as_schema_mut(&mut self) -> SchemaRefMut<'_>where
Self: Sized,
fn as_schema_mut(&mut self) -> SchemaRefMut<'_>where
Self: Sized,
T
to a SchemaRefMut
Auto Trait Implementations§
impl !Freeze for RngGenerator
impl RefUnwindSafe for RngGenerator
impl Send for RngGenerator
impl Sync for RngGenerator
impl Unpin for RngGenerator
impl UnwindSafe for RngGenerator
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<S> FromSample<S> for S
impl<S> FromSample<S> for S
fn from_sample_(s: S) -> S
source§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere
T: Default,
source§fn from_world(_world: &World) -> T
fn from_world(_world: &World) -> T
Self
using data from the given World
.§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
§impl<F, T> IntoSample<T> for Fwhere
T: FromSample<F>,
impl<F, T> IntoSample<T> for Fwhere
T: FromSample<F>,
fn into_sample(self) -> T
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.source§impl<T> RawDefault for Twhere
T: Default,
impl<T> RawDefault for Twhere
T: Default,
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.