Skip to main content

Gen

Struct Gen 

Source
pub struct Gen {
    pub node_compat: bool,
    /* private fields */
}
Expand description

Seeded pseudo-random generator (SplitMix64).

Fields§

§node_compat: bool

Restrict values to what node-minecraft-protocol round-trips (its varlong is really 32-bit, its NBT root reader cannot take a bare TAG_End).

Implementations§

Source§

impl Gen

Source

pub fn new(seed: u64) -> Self

Creates a generator from a seed.

Source

pub fn u64(&mut self) -> u64

Next raw 64 random bits.

Source

pub fn below(&mut self, n: u64) -> u64

Uniform in 0..n (n > 0).

Source

pub fn chance(&mut self, percent: u64) -> bool

True with probability percent/100.

Source

pub fn bool(&mut self) -> bool

A random boolean.

Source

pub fn int_in(&mut self, lo: i64, hi: i64, hints: &[i64]) -> i64

An integer in [lo, hi], preferring hints, small values and the bounds.

Source

pub fn small_count(&mut self) -> u8

A count for a field that sizes an array (0..=3).

Source

pub fn count(&mut self) -> usize

A collection length (mostly small).

Source

pub fn i64(&mut self) -> i64

A random i64.

Source

pub fn varlong(&mut self) -> i64

A random VarLong value (non-negative 32-bit in node-compat mode: node’s varlong is really an unsigned 32-bit VarInt).

Source

pub fn f32(&mut self) -> f32

A random finite f32.

Source

pub fn f64(&mut self) -> f64

A random finite f64.

Source

pub fn uuid(&mut self) -> Uuid

A random UUID.

Source

pub fn string(&mut self) -> ByteString

A random string.

Source

pub fn string_in(&mut self, hints: &[&str]) -> ByteString

One of hints (usually) or a random string.

Source

pub fn bytes(&mut self) -> Bytes

Random bytes.

Source

pub fn position(&mut self) -> BlockPos

A random packable block position.

Source

pub fn nbt(&mut self) -> RawNbt

A random named root compound as raw NBT.

Source

pub fn opt_nbt(&mut self) -> Option<RawNbt>

Optional NBT (None 30% of the time).

Trait Implementations§

Source§

impl Clone for Gen

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Gen

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Gen

§

impl RefUnwindSafe for Gen

§

impl Send for Gen

§

impl Sync for Gen

§

impl Unpin for Gen

§

impl UnsafeUnpin for Gen

§

impl UnwindSafe for Gen

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.