GHC 10.0.0.20260917 · lts/ghc-10.0.x · 8fef28d · 2026-11-02
Modulebytebuild-0.3.17.0Haskell2010
The functions in this module are explict about the maximum number of bytes they require.
A builder parameterized by the maximum number of bytes it uses when executed.
ToBoundedBuilder (Builder n)Defined in bytebuild-0.3.17.0 · Data.Bytes.Builder.Bounded.ClassIdentity
type BoundedBuilderLength (Builder n) = nDefined in bytebuild-0.3.17.0 · Data.Bytes.Builder.Bounded.ClassExecute the bounded builder. If the size is a constant,
use Arithmetic.Nat.constant as the first argument to let
GHC conjure up this value for you.
Variant of run that puts the result in a pinned buffer and packs it up in a ByteString.
pasteGrowST :: Nat n-> Builder n-> MutableByteArrayOffset sInitial buffer, used linearly. Do not reuse this argument.
-> ST s (MutableByteArrayOffset s)Final buffer that accomodated the builder.
Paste the builder into the byte array starting at offset zero. This reallocates the byte array if it cannot accomodate the builder, growing it by the minimum amount necessary.
The monoidal unit of append
Concatenate two builders.
Weaken the bound on the maximum number of bytes required. For example, to use two builders with unequal bounds in a disjunctive setting:
import qualified Arithmetic.Lte as Lte
buildNumber :: Either Double Word64 -> Builder 32
buildNumber = \case
Left d -> doubleDec d
Right w -> weaken (Lte.constant @19 @32) (word64Dec w)Replace the upper bound on size with an equal number.
Requires up to 19 bytes. Encodes an unsigned 64-bit integer as decimal. This encoding never starts with a zero unless the argument was zero.
Requires up to 10 bytes. Encodes an unsigned 32-bit integer as decimal. This encoding never starts with a zero unless the argument was zero.
Requires up to 5 bytes. Encodes an unsigned 16-bit integer as decimal. This encoding never starts with a zero unless the argument was zero.
Requires up to 3 bytes. Encodes an unsigned 8-bit integer as decimal. This encoding never starts with a zero unless the argument was zero.
Requires up to 19 bytes. Encodes an unsigned machine-sized integer as decimal. This encoding never starts with a zero unless the argument was zero.
Requires up to 20 bytes. Encodes a signed 64-bit integer as decimal. This encoding never starts with a zero unless the argument was zero. Negative numbers are preceded by a minus sign. Positive numbers are not preceded by anything.
Requires up to 11 bytes. Encodes a signed 32-bit integer as decimal. This encoding never starts with a zero unless the argument was zero. Negative numbers are preceded by a minus sign. Positive numbers are not preceded by anything.
Requires up to 6 bytes. Encodes a signed 16-bit integer as decimal. This encoding never starts with a zero unless the argument was zero. Negative numbers are preceded by a minus sign. Positive numbers are not preceded by anything.
Requires up to 4 bytes. Encodes a signed 8-bit integer as decimal. This encoding never starts with a zero unless the argument was zero. Negative numbers are preceded by a minus sign. Positive numbers are not preceded by anything.
Requires up to 20 bytes. Encodes a signed machine-sized integer as decimal. This encoding never starts with a zero unless the argument was zero. Negative numbers are preceded by a minus sign. Positive numbers are not preceded by anything.
Requires exactly 32 bytes. Encodes a 128-bit unsigned integer as hexadecimal, zero-padding the encoding to 32 digits. This uses lowercase for the alphabetical digits.
Requires exactly 32 bytes. Encodes a 128-bit unsigned integer as hexadecimal, zero-padding the encoding to 32 digits. This uses uppercase for the alphabetical digits.
Requires exactly 64 bytes. Encodes a 256-bit unsigned integer as hexadecimal, zero-padding the encoding to 64 digits. This uses lowercase for the alphabetical digits.
Requires exactly 64 bytes. Encodes a 256-bit unsigned integer as hexadecimal, zero-padding the encoding to 64 digits. This uses uppercase for the alphabetical digits.
Requires exactly 16 bytes. Encodes a 64-bit unsigned integer as
hexadecimal, zero-padding the encoding to 16 digits. This uses
lowercase for the alphabetical digits. For example, this encodes the
number 1022 as 00000000000003fe.
Requires exactly 16 bytes. Encodes a 64-bit unsigned integer as
hexadecimal, zero-padding the encoding to 16 digits. This uses
uppercase for the alphabetical digits. For example, this encodes the
number 1022 as 00000000000003FE.
Requires exactly 12 bytes. Discards the upper 16 bits of a
64-bit unsigned integer and then encodes the lower 48 bits as
hexadecimal, zero-padding the encoding to 12 digits. This uses
lowercase for the alphabetical digits. For example, this encodes the
number 1022 as 0000000003fe.
Requires exactly 8 bytes. Encodes a 32-bit unsigned integer as hexadecimal, zero-padding the encoding to 8 digits. This uses lowercase for the alphabetical digits.
Requires exactly 8 bytes. Encodes a 32-bit unsigned integer as hexadecimal, zero-padding the encoding to 8 digits. This uses uppercase for the alphabetical digits.
Requires exactly 4 bytes. Encodes a 16-bit unsigned integer as hexadecimal, zero-padding the encoding to 4 digits. This uses lowercase for the alphabetical digits.
word16PaddedLowerHex 0xab00ab0
Requires exactly 4 bytes. Encodes a 16-bit unsigned integer as hexadecimal, zero-padding the encoding to 4 digits. This uses uppercase for the alphabetical digits.
word16PaddedUpperHex 0xab00AB0
Requires at most 4 bytes. Encodes a 16-bit unsigned integer as hexadecimal. No leading zeroes are displayed. Letters are presented in lowercase. If the number is zero, a single zero digit is used.
word16LowerHex 0xab0ab0
Requires at most 4 bytes. Encodes a 16-bit unsigned integer as hexadecimal. No leading zeroes are displayed. Letters are presented in uppercase. If the number is zero, a single zero digit is used.
word16UpperHex 0xab0AB0
Requires exactly 2 bytes. Encodes a 8-bit unsigned integer as hexadecimal, zero-padding the encoding to 2 digits. This uses lowercase for the alphabetical digits.
Requires exactly 2 bytes. Encodes a 8-bit unsigned integer as hexadecimal, zero-padding the encoding to 2 digits. This uses uppercase for the alphabetical digits.
Requires at most 2 bytes. Encodes a 8-bit unsigned integer as hexadecimal. No leading zeroes are displayed. If the number is zero, a single zero digit is used.
Encode an ASCII character. Precondition: Input must be an ASCII character. This is not checked.
Encode two ASCII characters. Precondition: Must be an ASCII characters. This is not checked.
Encode three ASCII characters. Precondition: Must be an ASCII characters. This is not checked.
Encode four ASCII characters. Precondition: Must be an ASCII characters. This is not checked.
Encode five ASCII characters. Precondition: Must be an ASCII characters. This is not checked.
Encode six ASCII characters. Precondition: Must be an ASCII characters. This is not checked.
Encode seven ASCII characters. Precondition: Must be an ASCII characters. This is not checked.
Encode eight ASCII characters. Precondition: Must be an ASCII characters. This is not checked.
Encode a character as UTF-8. This only uses as much space as is required.
Encode a number less than 100 as a decimal number, zero-padding it to
two digits. For example: 0 is encoded as 00, 5 is encoded as 05, and
73 is encoded as 73.
Precondition: Argument must be less than 100. Failure to satisfy this precondition will not result in a segfault, but the resulting bytes are undefined. The implemention uses a heuristic for division that is inaccurate for large numbers.
Encode a number less than 10000 as a decimal number, zero-padding it to
two digits. For example: 0 is encoded as 0000, 5 is encoded as 0005,
and 73 is encoded as 0073.
Precondition: Argument must be less than 10000. Failure to satisfy this precondition will not result in a segfault, but the resulting bytes are undefined. The implemention uses a heuristic for division that is inaccurate for large numbers.
Encode a number less than 1e9 as a decimal number, zero-padding it to
nine digits. For example: 0 is encoded as 000000000 and 5 is encoded as
000000005.
Precondition: Argument must be less than 1e9. Failure to satisfy this precondition will not result in a segfault, but the resulting bytes are undefined. The implemention uses a heuristic for division that is inaccurate for large numbers.
Requires exactly 8 bytes. Dump the octets of a 64-bit word in a big-endian fashion.
Requires exactly 4 bytes. Dump the octets of a 32-bit word in a big-endian fashion.
Requires exactly 2 bytes. Dump the octets of a 16-bit word in a big-endian fashion.
Requires exactly 8 bytes. Dump the octets of a 64-bit word in a little-endian fashion.
Requires exactly 4 bytes. Dump the octets of a 32-bit word in a little-endian fashion.
Requires exactly 2 bytes. Dump the octets of a 16-bit word in a little-endian fashion.
LEB128 encodes an integer in 7-bit units, least significant bits first, with the high bit of each output byte set to 1 in all bytes except for the final byte.
Encode a machine-sized word with LEB-128.
Encode a 32-bit word with LEB-128.
Encode a 32-bit word with LEB-128.
Encode a 64-bit word with LEB-128.
VLQ (also known as VByte, Varint, VInt) encodes an integer in 7-bit units, most significant bits first, with the high bit of each output byte set to 1 in all bytes except for the final byte.
Encode a machine-sized word with VLQ (also known as VByte, Varint, VInt).
Encode a 32-bit word with VLQ (also known as VByte, Varint, VInt).
Encode a 64-bit word with VLQ (also known as VByte, Varint, VInt).
Encode a double-floating-point number, using decimal notation or
scientific notation depending on the magnitude. This has undefined
behavior when representing +inf, -inf, and NaN. It will not
crash, but the generated numbers will be nonsense.