Skip to main content

gzerror

Function gzerror 

Source
pub unsafe extern "C" fn gzerror(
    file: gzFile,
    errnum: *mut c_int,
) -> *const c_char
Available on crate feature gz only.
Expand description

Retrieve the zlib error code and a human-readable string description of the most recent error on a gzip file stream.

§Arguments

  • file - A gzip file handle, or null
  • errnum - A pointer to a C integer in which the zlib error code should be written, or null if the caller does not need the numeric error code.

§Returns

  • A pointer to a null-terminated C string describing the error, if file is non-null and has an error
  • A pointer to an empty (zero-length), null-terminated C string, if file is non-null but has no error
  • Null otherwise

§Safety

file must be one of the following:

If this function returns a non-null string, the caller must not modifiy or deallocate the string.

If errnum is non-null, it must point to an address at which a c_int may be written.