Parsers that only work inside a bit context.

See Bits!

Consider using M! instead.

This is useful for when you are parsing a struct, have nesting, and want the nice syntax to replace F!!

Example:

|QoiHeader {Width Height Channels Colorspace}

QoiHeaderBin ← M!(
Z!QoiHeader
| Just!(-@\0"qoif")
| QoiHeader~Width = Ube₃₂
| QoiHeader~Height = Ube₃₂
| Sub!!2 Compose!(
| QoiHeader~Channels = Ube₈
| QoiHeader~Colorspace = Ube₈
)
)

Helper to create a compound data parser.

Please read to the end.

Example:

HeaderBin = M!(Z!Header
| F!!Ube,32 Header~Abc
)

This can also be used to parse tuples:

Test = M!([0 0]
| F!!Ube,32 pick,0
| F!!Ube,32 pick,1
)

There is also comptime syntax so you don't have to type F!!:

|QoiHeader {Width Height Channels Colorspace}

QoiHeaderBin ← M!(
Z!QoiHeader
| Just!(-@\0"qoif")
| QoiHeader~Width = Ube₃₂
| QoiHeader~Height = Ube₃₂
| QoiHeader~Channels = Ube₈
| QoiHeader~Colorspace = Ube₈
)

Also consider using MS!, for even cleaner code.

Read the documentation for M! first.

Example:

|QoiHeader {Width Height Channels Colorspace}

QoiHeaderBin ← B~MS!(
QoiHeader
| Just!(-@\0"qoif")
| Width ← Ube₃₂
| Height ← Ube₃₂
| Channels ← Ube₈
| Colorspace ← Ube₈
)

decode a prefixed variant

example:

V!(
Ule₈
| 0 => Ule₁₆
| . => Ube₁₆
)

if the variant ID is not a prefix, consider using this in combination with Ref!

the value of this parser depends on which variant is chosen

It uses cursed.ua for parsing the match arms

Runs the given parser in a bit context.

This means that it will input and output bits instead of bytes

Converts all input bytes to bits, applies the parser, and then converts the remaining bits back to bytes.

for performance reasons, consider limiting the resulting parser using Sub!

inside a struct context, consider using this with Compose!

insert ^0 bytes that can be any value / padding bytes

applies the parser, but pushes the amount of bytes it consumed / created onto the stack.

this can not be un-ed, but you can use UnLen!

pad output of parser ^1 to ^0 bytes with trailing zeros

assign the value of parser ^0 to struct field ^1

you can use this in M!!

a parser that encodes / matches and returns ^0

example:

Just!(-@\0"png")

parse length-prefixed array.

macro arguments:

1. parser for array len prefix
2. parser for array elem

if the array length is not a prefix, consider using this in combination with Ref!

you might want to box the value of the inner parser using Map!!

parses an array of a fixed length

macro arguments:

1. array length (constant)
2. parser for array elem

example:

F!! NArr!!4 Ule,8

applies the given parser (to generate an array) until no more bytes are left

This function is deprecated and will be removed in the future.

Either use Z! from cursed.ua directly, or use MS!!

Helper to create a compound data parser.

YOU PROBABLY DON'T WANT TO USE THIS DIRECTLY. USE M! INSTEAD

Example:

HeaderBin = MCtx!!Z!Header(
F!!Ube,32 Header~Abc
)

This can also be used to parse tuples:

Test = MCtx!![0 0](
F!!Ube,32 pick,0
F!!Ube,32 pick,1
)

modify value after it is parsed. also works with un by modifying the value before it is encoded.

Example:

Map!!box Arr!!Ule,16 U,8

decode a prefixed variant type

parsers of variants can have any amount of outputs

example:

#if u8 is 0, decode LE u16, otherwise BE u16
Var‼Ule₈C~InvTry!(
VarEnt‼0 Ule₁₆
| VarEnt‼1 Ube₁₆
| VarFail)

generated parser signature: RemBytes Variant Value ? Bytes

you might want to put this into Multi!

YOU PROBABLY WANT TO USE``V!!` INSTEAD

A parser that returns the value from the struct field, (or sets the value from the struct field in encode)

Works only inside a M!! context

this can be used together with other parsers, such as Arr!!, when the length is not a prefix:

~Struct { CoolArr CoolArrLen }

M!!Z!Struct(
F!! Ule,32 Struct~CoolArrLen
...
F!! Arr!! Ref! Struct~CoolArrLen U,8 Struct~CoolArr
)

takes in a parser of signature Value ? Bytes, and parses the first N bytes with it

takes in a parser of signature Value ? Bytes, and parsers all remaining bytes with it

Runs the given parser in a sub-view of the bytes of length N.

This is useful for performance of bit parsers and also for until-end parsers.

This function is deprecated and will be removed in the future.

Use U,8 instead!

This function is deprecated and will be removed in the future.

Use I,8 instead!

This function is deprecated and will be removed in the future.

Use U,8 instead!

This function is deprecated and will be removed in the future.

Use I,8 instead!

null terminated byte array

null terminated utf8 string

AMD's 24 bit float format

BrainFloat 16

AMD's 24 bit float format

BrainFloat 16

parses nothing