tiny.deflate.Options
Defined in tiny.deflate.
Two checks that decompress runs after the decoder for the format finishes one compressed stream with whatever header and trailer its format adds, a frame, for a caller to choose how closely the frame must match the two buffers.
API (2)
Fields and members
Public fields and members.
Source
Source: lib/deflate/src/model.zig:28
zig
/// Two checks that `decompress` runs after the decoder for the format finishes one compressed/// stream with whatever header and trailer its format adds, a frame, for a caller to choose how/// closely the frame must match the two buffers. The defaults require the input to end with the/// frame and leave the output length free. The PDF reader passes the defaults, and the README/// example turns both checks on.pub const Options = struct { /// Turns on exact input: when true, bytes left in `input` after the frame fail the call with /// `error.TrailingInput`. The option defaults to true. A caller that reads one frame from the /// front of a longer buffer sets it to false and learns the frame's length from /// `Result.consumed`. exact_input: bool = true, /// Turns on exact output: when true, expanded data shorter than `output` fails the call with /// `error.BadSize`. The option defaults to false. A caller that knows the expanded size from /// elsewhere sets it and passes an output buffer of exactly that size. exact_output: bool = false,};Source: lib/deflate/src/root.zig:51
zig
pub const Options = model.Options;Audit
| Definitions | 1 |
|---|---|
| Public names | 1 |
| Members | 2 |
| Version | 26.7.0 |
| Revision | daab053ee433 |