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 › Frame › Zstandard › Decode › nextSequence Private Function nextSequence Doc Source Private Function std.compress.zstd.Decompress.Frame.Zstandard.Decode.nextSequence
fn nextSequence (
self : *Decode ,
bit_reader : *ReverseBitReader ,
) error Params File compress/zstd/Decompress.zig: 726
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771 fn nextSequence (
self : *Decode ,
bit_reader : *ReverseBitReader ,
) error { InvalidBitStream , EndOfStream }!Sequence {
const raw_code = self .getCode (.offset );
const offset_code = std .math .cast (u5 , raw_code ) orelse {
return error .InvalidBitStream ;
};
const offset_value = (@as (u32 , 1 ) << offset_code ) + try bit_reader .readBitsNoEof (u32 , offset_code );
const match_code = self .getCode (.match );
if (match_code >= zstd .match_length_code_table .len )
return error .InvalidBitStream ;
const match = zstd .match_length_code_table [match_code ];
const match_length = match [0 ] + try bit_reader .readBitsNoEof (u32 , match [1 ]);
const literal_code = self .getCode (.literal );
if (literal_code >= zstd .literals_length_code_table .len )
return error .InvalidBitStream ;
const literal = zstd .literals_length_code_table [literal_code ];
const literal_length = literal [0 ] + try bit_reader .readBitsNoEof (u32 , literal [1 ]);
const offset = if (offset_value > 3 ) offset : {
const offset = offset_value - 3 ;
self .updateRepeatOffset (offset );
break :offset offset ;
} else offset : {
if (literal_length == 0 ) {
if (offset_value == 3 ) {
const offset = self .repeat_offsets [0 ] - 1 ;
self .updateRepeatOffset (offset );
break :offset offset ;
}
break :offset self .useRepeatOffset (offset_value );
}
break :offset self .useRepeatOffset (offset_value - 1 );
};
if (offset == 0 ) return error .InvalidBitStream ;
return .{
.literal_length = literal_length ,
.match_length = match_length ,
.offset = offset ,
};
}