Interface IRandomSource

Minimal random source contract used by RandomUtil helpers and extensions. All RNG algorithms and adapters implement this interface to provide a unified abstraction for generating random values, allowing callers to swap algorithms without changing downstream code.

Namespace: Scylla.Core.Util.Random

Assembly: ScyllaCore.dll

Syntax

public interface IRandomSource

Remarks

Implementations include the built-in algorithm structs (Xoshiro256StarStar, Xoroshiro128Plus, PCG32, SplitMix64RNG, MersenneTwister) and the adapter classes (CryptoRandomSource, SystemRandomSource, UnityRandomSource).

The interface intentionally exposes only the lowest-level primitives (uint, ulong, and raw bytes). Higher-level operations such as bounded integers, floating-point values, shuffles, and weighted picks are provided as extension methods in RandomExtensions and static helpers in RandomUtil, all of which accept any IRandomSource.

Thread-safety is not guaranteed by this interface. Consult the documentation of each concrete implementation to determine its thread-safety characteristics.

Methods

NextBytes(byte[], int, int)

Fills a contiguous region of a byte array with pseudo-random bytes, one byte at a time, where each byte is independently and uniformly distributed in [0, 255].

Declaration

void NextBytes(byte[] buffer, int offset = 0, int count = -1)

Parameters

Type	Name	Description
byte[]	buffer	The destination byte array. Must not be `null`.
int	offset	The zero-based starting index within `buffer` at which filling begins. Must be in the range `[0, buffer.Length]`. Defaults to `0`.
int	count	The number of bytes to fill starting at `offset`. Pass `-1` (the default) to fill all bytes from `offset` to the end of the array, equivalent to `buffer.Length - offset`. The sum `offset + count` must not exceed `buffer.Length`.

Exceptions

Type	Condition
ArgumentNullException	Thrown when `buffer` is `null`.
ArgumentOutOfRangeException	Thrown when `offset` is negative or greater than `buffer.Length`, when `count` is less than `-1`, or when `offset + count` exceeds `buffer.Length`.

NextUInt32()

Returns a uniformly distributed, unsigned 32-bit pseudo-random integer spanning the full range [0, 2^32).

Declaration

uint NextUInt32()

Returns

Type	Description
uint	A random uint value in the range `[0, 4294967295]` (inclusive). All bit patterns are equally probable.

NextUInt64()

Returns a uniformly distributed, unsigned 64-bit pseudo-random integer spanning the full range [0, 2^64).

Declaration

ulong NextUInt64()

Returns

Type	Description
ulong	A random ulong value in the range `[0, 18446744073709551615]` (inclusive). All bit patterns are equally probable.

Remarks

Implementations that are natively 32-bit (e.g. PCG32) compose this value from two successive 32-bit draws. Implementations that are natively 64-bit (e.g. Xoshiro256StarStar) return the value directly, making this the preferred primitive for high-throughput scenarios.