Skip to content

Use partial flushes with miniz_oxide backend #496

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 19, 2025

Conversation

fintelia
Copy link
Contributor

I'll admit that I don't quite know why the code previously mapped FlushCompress::Partial to a sync flush

Copy link
Member

@Byron Byron left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for looking into this!

I think it's best to validate this change, which to my mind should be good.

@@ -136,7 +136,8 @@ impl From<FlushCompress> for MZFlush {
fn from(value: FlushCompress) -> Self {
match value {
FlushCompress::None => Self::None,
FlushCompress::Partial | FlushCompress::Sync => Self::Sync,
FlushCompress::Partial => Self::Partial,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@oyvindln Do you know if there was a reason not to use partial flushes before? If not, then it's probably safe to map it 1:1, but I wanted to check with you.
Thanks for your help!

Copy link
Contributor

@oyvindln oyvindln Jul 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have no idea - would have to look into it

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I looked into it by digging through the history, and it's unclear why things are the way they are.

There was a time when there was direct conversion.

        flush: FlushCompress,
    ) -> Result<Status, CompressError> {
        let flush = MZFlush::new(flush as i32).unwrap();

The revision that actually introduced this line didn't mention why either.

So I think it's fair to merge this.

@Byron Byron added the question label Jul 19, 2025
Copy link
Member

@Byron Byron left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After double-checking, I don't think we can find out why not to do it, without any indication of why that is in the Git history.

@Byron Byron merged commit 9f6b4b6 into rust-lang:main Jul 19, 2025
15 checks passed
@CosminPerRam
Copy link
Contributor

CosminPerRam commented Jul 25, 2025

Hey, this was done in #462, I mapped it this way because of the MZFlush::new i32 constructor (1 | 2 => MZFlush::Sync).

FlushCompress::Partial is 1, Sync is 2, so therefore this mapping (which kept original behaviour).

@fintelia
Copy link
Contributor Author

Yes, I discovered after this PR that miniz_oxide didn't support partial flushes, so I added them in Frommi/miniz_oxide#179. Thus, flate2 should avoid shipping this change until miniz_oxide makes a new release and this crate's version dependency is updated accordingly. With this change and the patch to miniz_oxide, #498 confirms that all backends implement all the flush types properly (at least for the one specific input that is tested).

(Someone should also probably make a PR to update the 1 | 2 => MZFlush::Sync line in miniz_oxide, I missed it when making my PR)

@fintelia fintelia deleted the flush-kinds branch July 25, 2025 17:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants