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 › BitReader › readBitsTuple Private Function readBitsTuple Doc Source Private Function std.compress.zstd.Decompress.BitReader.readBitsTuple
fn readBitsTuple (self : *@This (), comptime T : type , num : u16 ) !Bits (T ) Params self : *@This () T : type num : u16 File compress/zstd/Decompress.zig: 1893
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929 fn readBitsTuple (self : *@This (), 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 ),
};
const pos = @as (U , byte ) << @intCast (out_count );
out |= pos ;
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 ),
};
const pos = @as (U , final_byte & low_bit_mask [bits_left ]) << @intCast (out_count );
out |= pos ;
self .bits = final_byte >> @intCast (bits_left );
self .count = @intCast (keep );
return initBits (T , out , num );
}