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 › ReverseBitReader › readBitsTuple Private Function readBitsTuple Doc Source Private Function std.compress.zstd.Decompress.ReverseBitReader.readBitsTuple
fn readBitsTuple (self : *ReverseBitReader , comptime T : type , num : u16 ) !Bits (T ) Params File compress/zstd/Decompress.zig: 1805
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840 fn readBitsTuple (self : *ReverseBitReader , comptime T : type , num : u16 ) !Bits (T ) {
const UT = @Int (.unsigned , @bitSizeOf (T ));
const U = if (@bitSizeOf (T ) < 8 ) u8 else UT ;
if (num <= self .count ) return initBits (T , self .removeBits (@intCast (num )), num );
var out_count : u16 = self .count ;
var out : U = self .removeBits (self .count );
const full_bytes_left = (num - out_count ) / 8 ;
for (0 ..full_bytes_left ) |_ | {
const byte = takeByte (self ) catch |err | switch (err ) {
error .EndOfStream => return initBits (T , out , out_count ),
};
if (U == u8 ) out = 0 else out <<= 8 ;
out |= byte ;
out_count += 8 ;
}
const bits_left = num - out_count ;
const keep = 8 - bits_left ;
if (bits_left == 0 ) return initBits (T , out , out_count );
const final_byte = takeByte (self ) catch |err | switch (err ) {
error .EndOfStream => return initBits (T , out , out_count ),
};
out <<= @intCast (bits_left );
out |= final_byte >> @intCast (keep );
self .bits = final_byte & low_bit_mask [keep ];
self .count = @intCast (keep );
return initBits (T , out , num );
}