Zig 0.17.0-dev (Split by item) 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.
std › compress › flate › Container › Hasher › writeFooter Public Function writeFooter Doc Source Public Function std.compress.flate.Container.Hasher.writeFooter
pub fn writeFooter (hasher : *Hasher , writer : *std .Io .Writer ) std .Io .Writer .Error !void Params File compress/flate.zig: 119
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139 pub fn writeFooter (hasher : *Hasher , writer : *std .Io .Writer ) std .Io .Writer .Error !void {
switch (hasher .*) {
.gzip => |*gzip | {
// GZIP 8 bytes footer
// - 4 bytes, CRC32 (CRC-32)
// - 4 bytes, ISIZE (Input SIZE) - size of the original
// (uncompressed) input data modulo 2^32
try writer .writeInt (u32 , gzip .crc .final (), .little );
try writer .writeInt (u32 , gzip .count , .little );
},
.zlib => |*zlib | {
// ZLIB (RFC 1950) is big-endian, unlike GZIP (RFC 1952).
// 4 bytes of ADLER32 (Adler-32 checksum)
// Checksum value of the uncompressed data (excluding any
// dictionary data) computed according to Adler-32
// algorithm.
try writer .writeInt (u32 , zlib .adler , .big );
},
.raw => {},
}
}