tiny.deflate.decompress

1/// Expands one compressed stream with whatever header and trailer its format adds (a frame of2/// `input`), in the container that `format` names, into the front of `output`, so callers can3/// expand a compressed buffer, such as a PDF content stream, into memory they already own. The call4/// allocates nothing. The call returns the number of input bytes the frame used and the number of5/// bytes written to `output`. After a success, only the first `result.written` bytes of `output`6/// hold expanded data. After a failure, `output` may hold part of the expanded data. The zlib and7/// gzip checksums, and the gzip length, are checked before the call returns. The exact-input and8/// exact-output checks run after the frame and its checksum pass. With exact input on, which is the9/// default, bytes left after the frame fail with `error.TrailingInput`. With exact output on,10/// expanded data shorter than `output` fails with `error.BadSize`. A stream that needs more room11/// than `output` has fails with `error.OutputTooSmall`. Every other failure is one tag of `Error`12/// that describes the input. The PDF reader calls `decompress` with the zlib container and the13/// default options, and treats `error.OutputTooSmall` as its own capacity error.14pub fn decompress(15    input: []const u8,16    output: []u8,17    format: model.Format,18    options: model.Options,19) model.Error!model.Result {20    const result = switch (format) {21        .raw => try decode.raw(input, output),22        .zlib => try zlib(input, output),23        .gzip => try gzip(input, output),24    };25    if (options.exact_input and result.consumed != input.len) {26        return error.TrailingInput;27    }28    if (options.exact_output and result.written != output.len) {29        return error.BadSize;30    }31    return result;32}

1pub const decompress = frame.decompress;