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 Struct

Options

Public Struct
std.compress.zstd.Decompress.Options
pub const Options = struct

Fields

verify_checksum: bool = false

Verifying checksums is not implemented yet and will cause a panic if you set this to true.

window_len: u32 = zstd.default_window_len

The output buffer is asserted to have capacity for window_len plus zstd.block_size_max.

If window_len is too small, then some streams will fail to decompress with error.OutputBufferUndersize.

File

compress/zstd/Decompress.zig:29
29
30
31
32
33
34
35
36
37
38
39
40
pub const Options = struct {
    /// Verifying checksums is not implemented yet and will cause a panic if
    /// you set this to true.
    verify_checksum: bool = false,

    /// The output buffer is asserted to have capacity for `window_len` plus
    /// `zstd.block_size_max`.
    ///
    /// If `window_len` is too small, then some streams will fail to decompress
    /// with `error.OutputBufferUndersize`.
    window_len: u32 = zstd.default_window_len,
}