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. Private Struct

BlockHeader

Private Struct
std.compress.flate.Compress.BlockHeader
const BlockHeader = packed struct(u3)

Fields

final: bool
kind: enum(u2) { stored, fixed, dynamic, _ }

Structs

Functions

pub fn int(h: BlockHeader) u3

File

compress/flate/Compress.zig:207
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
const BlockHeader = packed struct(u3) {
    final: bool,
    kind: enum(u2) { stored, fixed, dynamic, _ },

    pub fn int(h: BlockHeader) u3 {
        return @bitCast(h);
    }

    pub const Dynamic = packed struct(u17) {
        regular: BlockHeader,
        hlit: u5,
        hdist: u5,
        hclen: u4,

        pub fn int(h: Dynamic) u17 {
            return @bitCast(h);
        }
    };
}