Skip to content
REFERENCE / ZLIB × LEAN

deflateResetKeep

Restart output and progress counters while retaining compression history.

Full chapter and shared rules ↗
int ZEXPORT deflateResetKeep(z_streamp strm);

Restart output and progress counters while retaining compression history.

Return values and next calls

Return type. int — zlib status code

The result says whether output progress was reset; success retains history that later compression may reference.

deflateResetKeep()
Returned value Meaning and conditions Caller’s next step
Z_OK
Progress reset; history retained
The stream is live in any phase. Counters, checksum and wrapper progress reset; pending output and unfinished lookahead are discarded, and the gzip header pointer is cleared. Continue only with history retention accounted for; use deflateReset for empty history. The stream still owns its allocations.
Z_STREAM_ERROR
Stream check failed
The stream check fails before normal operation; neither the stream nor result cells are written. Establish a live stream and the call preconditions; this result does not complete the operation.

Calling conditions and effects

Domain Restricted domain. Effect: reset, retaining history and allocations.

Pre live stream in any phase. Use deflateReset when the next compressed stream must start with empty history.

Proof goals. No required goal: zlib.h declares this function under "undocumented functions (not part of the zlib API)". A direct call is not a step of the deflate sequence goal either: StreamOperation leaves it out (deviations, row "Direct deflateResetKeep"). The single call has the functional goal Goal.deflateResetKeep (Functional/Lifecycle.lean) (not planned; a theorem proves it): ZlibF.Spec.Public.DeflateResetKeepProof.deflate_resetkeep_public (public-deflate-reset-keep.lean).

Complete return conditions and boundaries

Post return Z_OK. Totals become zero, msg becomes NULL and data_type becomes Z_UNKNOWN. Pending output, unfinished lookahead and bit/block progress are discarded; wrapper emission restarts and adler becomes 1 for raw/zlib or 0 for gzip. The custom gzip header pointer is cleared. Level, strategy, tuning, window and hash history are retained. I/O pointers and available counts are unchanged. No allocation or free occurs.

A later compressor call can refer to pre-reset history. This reset alone therefore does not promise a stream decodable with an empty dictionary.

Shared conditions and scope

Use a z_stream compressor when input arrives in pieces, output space is limited, or you need a chosen wrapper, dictionary or flush boundary. A wrapper is the header, trailer and integrity information added around the DEFLATE data; raw DEFLATE has none. Initialize once, call deflate with successive buffers, and end the stream even if compression is abandoned. For a single buffer, see compress and compress2.

Task Entries
Start or reuse Init, configured init, reset, reset retaining history
Supply metadata or history Dictionary, read history, gzip header
Compress and size output Deflate, bound, pending output, last flush bits
Adjust or branch Parameters, tuning, priming, copy
Release storage End

The contracts follow zlib.h and deflate.c of the pinned zlib with the patches applied, in the default LP64 Linux build. Of the seven patches only patches 0006 and 0007 touch deflate.c. Both change deflateBound_z, and with it the result of deflateBound, which calls deflateBound_z: 0006 one condition, 0007 the length of the gzip extra field in the wrapper size. The entry deflateBound_z states both changes. The patches change no other function. These are focused contracts: Pre describes ordinary correct use and is deliberately narrower than what the function accepts. Cases outside Pre that the C still handles appear under Errors or Outside focused scope. A call outside Pre is not thereby undefined, and it need not return an error code. See how to read a contract for the domain and effect labels.

What is proved. Safety only: each call returns without undefined behaviour or a memory error, writes only what its goal names, and leaks nothing (safety). Each entry gives its goal under Proof goals, in the five items and with the fixed phrases that Reading a Proof goals paragraph defines: the goal and its theorem; the conditions under which it applies, in the order of the Lean statement; what it covers for every value; what it guarantees (returns, state, writes, allocations); and what it leaves to another goal. The proof assumes the conditions listed there, not the documentary Pre. Post, the return tables and the notes describe functional behaviour. They are read from the C, are to confirm where no theorem states them, and are not required for the safety results. Progress says which goals are done.

Shared conventions

Under each stated Pre, the documented behaviour is that the call terminates without a runtime fault and that Post holds. A call that leaves the stream live preserves its representation invariant. The part of this that is proved is the safety goal of the entry.

First, how data changes hands in one call. next_in points to the start of the input not yet read, and avail_in is the number of bytes readable from there. next_out points to the next writable position, and avail_out is the output room that remains, also in bytes. One call may consume only part of the input and deliver only part of the output. Read the updated pointers and counts, take the bytes delivered, then give the same stream more input or more output room.

  • Live stream: a writable z_stream with a compressor state established by successful init or copy, preserved by legal calls, and not ended. The caller does not alter its internal state or allocator fields. Calls on one stream are sequential.
  • Buffers: input covers avail_in readable bytes; output covers avail_out writable bytes. They do not overlap each other, the stream or its owned state. A non-NULL scalar result points to a writable cell separate from other results and stream memory. These separation conditions are assumptions of the contracts. Where a safety goal assumes one too, its Proof goals says so and deviations has a row.
  • Allocator: the default allocator/free pair is used, or both fields are NULL before init. Allocation may fail on any attempt. Custom allocator callbacks are outside this page's scope.
  • Frame and ownership: calls change only their stream, its owned state and stated output regions. Caller input is read-only. Caller buffers and header records remain caller-owned. Only init and copy allocate; only their failure cleanup and deflateEnd free memory. Other calls preserve the stream's allocation set.
  • Header lifetime: a retained gzip header and its optional fields remain readable and unchanged while used. Non-NULL name and comment have a terminating zero; extra covers its stated length. The contracts on this page take extra_len <= 65535.
  • Checked refusals: except for init and bounds, a failed stream check returns Z_STREAM_ERROR before normal operation, without writes. deflateCopy additionally clears a non-NULL destination state. Query output cells are untouched on this refusal.
  • Restricted domain means these explicit memory, lifetime and call-order conditions, plus the entry's Pre. It does not mean every representable pointer or integer is accepted. Error summaries cover stream records and states that the checks can read, not arbitrary invalid addresses.
  • Reachable stream: the proof goals speak of a reachable stream where the contracts say live stream (how to read a contract). A call that a goal covers extends the stream's history: when it returns, with any code, the stream is reachable again and the goal of the next call applies. deflateEnd ends the history.
  • Result cells as values: deflateGetDictionary, deflatePending and deflateUsed report results through pointers (uInt *dictLength, unsigned *pending, int *bits). The translation does not model these cells as memory: each function takes only the fact that a pointer is NULL or not, and returns the values. So the goals say nothing about the address of a result cell, and a cell that overlaps another object cannot be expressed.

Functional contract (beyond safety)

ZlibF.Spec.Public.Goal.deflateResetKeep

State: done · Status of the results

/-- `int deflateResetKeep(z_streamp strm)`; reset progress while retaining the match history. -/
def Goal.deflateResetKeep : Prop := DeflateResetContract Zlib.Deflate.deflateResetKeep true
Related definitions and source ↗
ZLIB × LEAN

Contents

READING NOWdeflateResetKeep