RandomModule

PackageAxial.PlatformService
Helpers for the random-number service.

Summary

NameSignatureSynopsis
serviceRandom.service Reads the service from the environment.
nextRandom.next Reads a non-negative random integer from an explicit random-number service.
nextMaxRandom.nextMax maxExclusiveReads a random integer less than the supplied maximum from an explicit random-number service.
nextIntRandom.nextInt minInclusive maxExclusiveReads a random integer from an explicit random-number service.
nextDoubleRandom.nextDouble Reads a random floating-point value from an explicit random-number service.
nextBytesRandom.nextBytes bufferFills a byte buffer through an explicit random-number service.
bytesRandom.bytes countCreates a byte array filled through an explicit random-number service.
liveRandom.live Creates a live random-number generator backed by .
fromValueRandom.fromValue valueCreates a deterministic random generator that always returns the supplied value.
fromFixedRandom.fromFixed integer doubleValue byteValueCreates a deterministic random generator from fixed integer, double, and byte values.
layerRandom.layer Builds the live random-number generator as a layer.

service

Random.service
Member
Reads the service from the environment.

Returns

Flow<'env, 'error, IRandom>

next

Random.next
Member
Reads a non-negative random integer from an explicit random-number service.

Returns

Flow<'env, 'error, int>

nextMax

Random.nextMax maxExclusive
Member
Reads a random integer less than the supplied maximum from an explicit random-number service.

Parameters

NameTypeDescription
maxExclusiveint

Returns

Flow<'env, 'error, int>

nextInt

Random.nextInt minInclusive maxExclusive
Member
Reads a random integer from an explicit random-number service.

Parameters

NameTypeDescription
minInclusiveint
maxExclusiveint

Returns

Flow<'env, 'error, int>

nextDouble

Random.nextDouble
Member
Reads a random floating-point value from an explicit random-number service.

Returns

Flow<'env, 'error, float>

nextBytes

Random.nextBytes buffer
Member
Fills a byte buffer through an explicit random-number service.

Parameters

NameTypeDescription
bufferbyte array

Returns

Flow<'env, 'error, unit>

bytes

Random.bytes count
Member
Creates a byte array filled through an explicit random-number service.

Parameters

NameTypeDescription
countint

Returns

Flow<'env, 'error, byte array>

live

Random.live
Member
Creates a live random-number generator backed by Random.

Returns

IRandom

fromValue

Random.fromValue value
Member
Creates a deterministic random generator that always returns the supplied value.

Parameters

NameTypeDescription
valueint

Returns

IRandom

fromFixed

Random.fromFixed integer doubleValue byteValue
Member
Creates a deterministic random generator from fixed integer, double, and byte values.

Parameters

NameTypeDescription
integerint
doubleValuefloat
byteValuebyte

Returns

IRandom

layer

Random.layer
Member
Builds the live random-number generator as a layer.

Returns

Layer<unit, Never, IRandom>