It seems flate2 documentation is wrong.

/// Returns an integer representing the compression level, typically on a
/// scale of 0-9
pub fn level(&self) -> u32 {
    self.0
}

But internally, inside DeflateBackend::make they have debug_assert!(level.level() <= 10);. Using compression level up to 10 works fine but panics for bigger values.

@JakkuSakura After discussing with flate2 maintainers, I've confirmed that it's actually a documentation issue, but there's a slight caveat as well. flate2 supports both miniz and zlib backends, the former enabled by default.

For consistency with zlib (which supports up to 9), the documentation states the compression range as 0-9, but 10 is supported miniz, enabled by default. If the backend is switched to zlib, then an attempt to use a compression level 10 will cause a panic.

I've opened a pull request in flate2 to explicitly mention this in the docs, so that there's no confusion around this behavior. I hope this resolves your query?

One more thing to add here. Parquet (and the entire arrow project) uses flate2 with rust_backend feature enabled. Which uses miniz backend, thereby supporting level 10 compression, aka UBER COMPRESSION. Flate2 still chooses to call 9 as the best level of compression because with 10 we might run into performance issues on the user's device.

The PR I created in flate2 is merged. So the docs should mention this caveat very soon hopefully. But behaviorally speaking, using level = 10 in parquet shouldn't be a problem at all. Discretion is advised when using flate2 separately.

@alamb @tustvold what do you think? And should we close this?

Maybe we can add a note to the arrow documentation with a link to flate2 and close this issuse?

Sounds like a good idea. I'll make this a part of #37 exercise itself.

@alamb @tustvold have a look please before I add anything to the docs.

rust-lang/flate2-rs#427 (comment) and rust-lang/flate2-rs#429

@alamb @tustvold have a look please before I add anything to the docs.

rust-lang/flate2-rs#427 (comment) and rust-lang/flate2-rs#429

I recommend linking to the docs added in rust-lang/flate2-rs#430 -- they are pretty clear to me. Basically we can say the max is 10 but offer the caveat that nothing else will be able to read the parquet files

Thanks for clarifying everything here. After the docs changes, nobody be confused by this

Summarizing for future visitors:

flate2 supports zlib and miniz backends. Both support levels 0-9 compression. However, miniz also supports a level 10, calling it UBER COMPRESSION. It also makes it clear that it's non-standard compression level and hence any data compressed using level 10 compression will not be readable by a standard GZIP reader.

Parquet (and Arrow) uses flate2 with miniz enabled. Therefore by extension, using level 10 compression in Parquet would mean that the generated file won't be readable by any other Parquet reader.

Users should not use level 10 compression with parquet if they intend to read the file with other readers as well.

References:

rust-lang/flate2-rs#427 (comment)
rust-lang/flate2-rs#430
https://github.com/Frommi/miniz_oxide/blob/master/miniz/miniz.h#L235
https://github.com/Frommi/miniz_oxide/blob/master/miniz/miniz.h#L229