Struct bones_framework :: networking :: random :: RngGenerator Copy item path

impl RngGenerator

pub fn new(seed: u64) -> Self

Creates a new RngGenerator, initializing it with the provided seed

pub fn gen_u8(&mut self) -> u8

Generate a random u8

pub fn gen_u8_range<R: RangeBounds<u8>>(&mut self, range: R) -> u8

Generate a random u8 within the given range

pub fn gen_i8(&mut self) -> i8

Generate a random i8

pub fn gen_i8_range<R: RangeBounds<i8>>(&mut self, range: R) -> i8

Generate a random i8 within the given range

pub fn gen_u16(&mut self) -> u16

Generate a random u16

pub fn gen_u16_range<R: RangeBounds<u16>>(&mut self, range: R) -> u16

Generate a random u16 within the given range

pub fn gen_i16(&mut self) -> i16

Generate a random i16

pub fn gen_i16_range<R: RangeBounds<i16>>(&mut self, range: R) -> i16

Generate a random i16 within the given range

pub fn gen_u32(&mut self) -> u32

Generate a random u32

pub fn gen_u32_range<R: RangeBounds<u32>>(&mut self, range: R) -> u32

Generate a random u32 within the given range

pub fn gen_i32(&mut self) -> i32

Generate a random i32

pub fn gen_i32_range<R: RangeBounds<i32>>(&mut self, range: R) -> i32

Generate a random i32 within the given range

pub fn gen_u64(&mut self) -> u64

Generate a random u64

pub fn gen_u64_range<R: RangeBounds<u64>>(&mut self, range: R) -> u64

Generate a random u64 within the given range

pub fn gen_i64(&mut self) -> i64

Generate a random i64

pub fn gen_i64_range<R: RangeBounds<i64>>(&mut self, range: R) -> i64

Generate a random i64 within the given range

pub fn gen_usize(&mut self) -> usize

Generate a random usize

pub fn gen_usize_range<R: RangeBounds<usize>>(&mut self, range: R) -> usize

Generate a random usize within the given range

pub fn gen_isize(&mut self) -> isize

Generate a random isize

pub fn gen_isize_range<R: RangeBounds<isize>>(&mut self, range: R) -> isize

Generate a random isize within the given range

pub fn gen_f32(&mut self) -> f32

Generate a random f32

pub fn gen_f32_range<R: RangeBounds<f32>>(&mut self, range: R) -> f32

Generate a random f32 within the given range

pub fn gen_f64(&mut self) -> f64

Generate a random f64

pub fn gen_f64_range<R: RangeBounds<f64>>(&mut self, range: R) -> f64

Generate a random f64 within the given range

pub fn gen_bool(&mut self) -> bool

Generate a random bool

pub fn gen_vec2(&mut self) -> Vec2

Generate a random 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

pub fn gen_vec3(&mut self) -> Vec3

Generate a random 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

pub fn shuffle_vec<T>(&mut self, vec: &mut [T])

Shuffle a Vec in place

pub fn shuffle_svec<T: HasSchema>(&mut self, svec: &mut SVec<T>)

Shuffle an SVec in place

pub fn shuffle_vecdeque<T>(&mut self, deque: &mut VecDeque<T>)

Shuffle a VecDeque in place

pub fn gen_alphabetic(&mut self) -> char

Generates a random char in ranges a-z and A-Z.

pub fn gen_alphanumeric(&mut self) -> char

Generates a random char in ranges a-z, A-Z and 0-9.

pub fn gen_lowercase(&mut self) -> char

Generates a random char in the range a-z.

pub fn gen_uppercase(&mut self) -> char

Generates a random char in the range A-Z.

pub fn gen_digit(&mut self, radix: u8) -> char

Generate a random digit in the given radix. Digits are represented by chars in ranges 0-9 and a-z.

§Panics

Panics if the radix is zero or greater than 36.

pub fn gen_char<R: RangeBounds<char>>(&mut self, bounds: R) -> char

Generates a random char in the given range.

§Panics

Panics if the range is empty.

pub fn gen_random_ascii_char(&mut self) -> char

Generate a random printable ASCII character

pub fn gen_random_ascii_string(&mut self, length: u64) -> String

Generate a random ASCII string of the specified length

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.

pub fn gen_sample<'a, T>(&mut self, list: &'a [T]) -> Option<&'a T>

Samples a random item from a slice of values.

pub fn gen_sample_iter<T: Iterator>(&mut self, list: T) -> Option<T::Item>

Samples a random item from an iterator of values.

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.

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.

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.

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.

pub fn gen_weighted_sample<'a, T, F>( &mut self, list: &'a [T], weight_sampler: F, ) -> Option<&'a T>
where F: Fn((&T, usize)) -> f64,

Stochastic Acceptance implementation of Roulette Wheel weighted selection.

pub fn gen_weighted_sample_mut<'a, T, F>( &mut self, list: &'a mut [T], weight_sampler: F, ) -> Option<&'a mut T>
where F: Fn((&T, usize)) -> f64,

Stochastic Acceptance implementation of Roulette Wheel weighted selection for mutable references.

Trait Implementations§

impl Clone for RngGenerator

fn clone(&self) -> RngGenerator

Returns a copy of the value. Read more

1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Default for RngGenerator

fn default() -> Self

Creates a new RngGenerator, initializing it with a harcoded seed

impl HasSchema for RngGenerator

fn schema() -> &'static Schema

Get this type’s [Schema].

fn register_schema()

Register this schema with the global schema registry. Read more

fn cast<T>(this: &Self) -> &T
where T: HasSchema,

Cast a reference of this type to a reference of another type with the same memory layout. Read more

fn try_cast<T>(this: &Self) -> Result<&T, SchemaMismatchError>
where T: HasSchema,

Cast a reference of this type to a reference of another type with the same memory layout. Read more

fn cast_mut<T>(this: &mut Self) -> &mut T
where T: HasSchema,

Cast a mutable reference of this type to a reference of another type with the same memory layout. Read more

fn try_cast_mut<T>(this: &mut Self) -> Result<&mut T, SchemaMismatchError>
where T: HasSchema,

Cast a mutable reference of this type to a reference of another type with the same memory layout. Read more

fn as_schema_ref(&self) -> SchemaRef<'_>
where Self: Sized,

Converts a reference of T to a SchemaRef

fn as_schema_mut(&mut self) -> SchemaRefMut<'_>
where Self: Sized,

Converts a reference of T to a SchemaRefMut

Auto Trait Implementations§

impl UnwindSafe for RngGenerator

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

impl<T> Conv for T

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more

impl<T> DynClone for T
where T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<S> FromSample<S> for S

fn from_sample_(s: S) -> S

impl<T> FromWorld for T
where T: Default,

fn from_world(_world: &World) -> T

Creates Self using data from the given World.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoArcAny for T
where T: Send + Sync + 'static,

fn into_arc_any(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Casts Arc<Self> into Arc<dyn Any + Send + Sync>.

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

fn into_sample(self) -> T

impl<T> Pipe for T
where T: ?Sized,

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows 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) -> R
where R: 'a,

Mutably borrows 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
where Self: Borrow, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef, U: 'a + ?Sized, R: 'a,

Borrows 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
where Self: AsMut, U: 'a + ?Sized, R: 'a,

Mutably borrows 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
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.

impl<T> RawClone for T
where T: Clone,

unsafe fn raw_clone(src: const c_void, dst: mut c_void)

Write the default value of the type to the pointer. Read more

fn raw_clone_cb() -> Unsafe<&'static (dyn Fn(const c_void, mut c_void) + Send + Sync)>

Get a callback suitable for [SchemaData].

impl<T> RawDefault for T
where T: Default,

unsafe fn raw_default(dst: *mut c_void)

Write the default value of the type to the pointer. Read more

fn raw_default_cb() -> Unsafe<&'static (dyn Fn(*mut c_void) + Send + Sync)>

Get a callback suitable for [SchemaData].

impl<T> RawDrop for T

unsafe fn raw_drop(ptr: *mut c_void)

Write the default value of the type to the pointer. Read more

fn raw_drop_cb() -> Unsafe<&'static (dyn Fn(*mut c_void) + Send + Sync)>

Get a callback suitable for [SchemaData].

impl<T> Same for T

type Output = T

Should always be Self

impl<'gc, T> Singleton<'gc> for T
where T: Default,

fn create(_: Context<'gc>) -> T

impl<T> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Immutable access to the Borrow of a value. Read more

fn tap_borrow_mut(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Mutable access to the BorrowMut of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.

fn tap_borrow_dbg(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.

fn tap_borrow_mut_dbg(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .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
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> ToSample for T
where U: FromSample<T>,

fn to_sample_(self) -> U

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more

impl<T, U> TryFrom for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,