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. Public Function
Returns the number of bytes consumed by the chunk size. This is always less than or equal to bytes.len.
After this function returns, chunk_len will contain the parsed chunk size in bytes when state is data. Alternately, state may become invalid, indicating a syntax error in the input stream.
If the amount returned is less than bytes.len, the parser is in the chunk_data state and the first byte of the chunk is at bytes[result].
Returns the number of bytes consumed by the chunk size. This is always less than or equal to
bytes.len.After this function returns,
chunk_lenwill contain the parsed chunk size in bytes whenstateisdata. Alternately,statemay becomeinvalid, indicating a syntax error in the input stream.If the amount returned is less than
bytes.len, the parser is in thechunk_datastate and the first byte of the chunk is atbytes[result].Asserts
stateis neitherdatanorinvalid.