Zig 0.17.0-dev (Split by item)

Shortcut keys
?
Show these tips
S
Focus search field
Esc
Clear focus & close tips
U
Jump to source code
↑
Move up in search results
↓
Move down in search results
↵
Go to active search result
This is an example of documentation generated by ZigDoc, an alternative to Zig's built-in Auto Doc feature. See also examples in other modes/formats. The project being documented here (as the example) is the Zig standard library. Public Constant

PrepareError

Public Constant
std.compress.zstd.Decompress.Frame.Zstandard.Decode.PrepareError
pub const PrepareError = error

Errors

MissingStartBit

the (reversed) literal bitstream's first byte does not have any bits set

TreelessLiteralsFirst

literals is a treeless literals section and the decode state does not have a Huffman tree from a previous block

RepeatModeFirst

on the first call if one of the sequence FSE tables is set to repeat mode

MalformedAccuracyLog

an FSE table has an invalid accuracy

MalformedFseTable

failed decoding an FSE table

EndOfStream

input stream ends before all FSE tables are read

ReadFailed
InputBufferUndersize

File

compress/zstd/Decompress.zig:565
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
            pub const PrepareError = error{
                /// the (reversed) literal bitstream's first byte does not have any bits set
                MissingStartBit,
                /// `literals` is a treeless literals section and the decode state does not
                /// have a Huffman tree from a previous block
                TreelessLiteralsFirst,
                /// on the first call if one of the sequence FSE tables is set to repeat mode
                RepeatModeFirst,
                /// an FSE table has an invalid accuracy
                MalformedAccuracyLog,
                /// failed decoding an FSE table
                MalformedFseTable,
                /// input stream ends before all FSE tables are read
                EndOfStream,
                ReadFailed,
                InputBufferUndersize,
            }