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 › zstd › Decompress › LiteralsSection › decode Public Function decode Doc Source Public Function std.compress.zstd.Decompress.LiteralsSection.decode
pub fn decode (in : *Reader , remaining : *Limit , buffer : []u8 ) DecodeError !LiteralsSection Params File compress/zstd/Decompress.zig: 1305
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348 pub fn decode (in : *Reader , remaining : *Limit , buffer : []u8 ) DecodeError !LiteralsSection {
const header = try Header .decode (in , remaining );
switch (header .block_type ) {
.raw => {
if (buffer .len < header .regenerated_size ) return error .MalformedLiteralsSection ;
remaining .* = remaining .subtract (header .regenerated_size ) orelse return error .EndOfStream ;
try in .readSliceAll (buffer [0 ..header .regenerated_size ]);
return .{
.header = header ,
.huffman_tree = null ,
.streams = .{ .one = buffer },
};
},
.rle => {
remaining .* = remaining .subtract (1 ) orelse return error .EndOfStream ;
buffer [0 ] = try in .takeByte ();
return .{
.header = header ,
.huffman_tree = null ,
.streams = .{ .one = buffer [0 ..1 ] },
};
},
.compressed , .treeless => {
const before_remaining = remaining .*;
const huffman_tree = if (header .block_type == .compressed )
try HuffmanTree .decode (in , remaining )
else
null ;
const huffman_tree_size = @backingInt (before_remaining ) - @backingInt (remaining .*);
const total_streams_size = std .math .sub (usize , header .compressed_size .?, huffman_tree_size ) catch
return error .MalformedLiteralsSection ;
if (total_streams_size > buffer .len ) return error .MalformedLiteralsSection ;
remaining .* = remaining .subtract (total_streams_size ) orelse return error .EndOfStream ;
try in .readSliceAll (buffer [0 ..total_streams_size ]);
const stream_data = buffer [0 ..total_streams_size ];
const streams = try Streams .decode (header .size_format , stream_data );
return .{
.header = header ,
.huffman_tree = huffman_tree ,
.streams = streams ,
};
},
}
}