Skip to content

Conversation

@romuald
Copy link
Contributor

@romuald romuald commented Sep 18, 2025

Replace the fixed size buffer example with a dynamic Vec

Since the buffer size was of fixed, size, the resulting zip file was always the same size, defeating the purpose of compression

fixes #430

Replace the fixed size buffer example with a dynamic Vec

Since the buffer size was of fixed, size, the resulting zip file was always the
same size, defeating the purpose of compression
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @romuald, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request updates the zip_writer documentation example to use a dynamic Vec for its internal buffer instead of a fixed-size array. This change is crucial because the previous fixed-size buffer inadvertently limited the output zip file to a constant size, which undermined the demonstration of compression capabilities. By switching to a dynamic Vec, the example now accurately reflects how zip_writer handles varying output sizes and compression, and also shows how to retrieve the resulting bytes.

Highlights

  • Documentation Example Update: The zip_writer documentation example now utilizes a dynamic Vec instead of a fixed-size buffer. This change rectifies an issue where the fixed-size buffer prevented the proper demonstration of compression, as the output zip file size was always constant.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request improves the ZipWriter documentation example by using a dynamic Vec instead of a fixed-size buffer, which is a great change. My review includes a minor suggestion to make the example code even more idiomatic by adjusting how the writer's ownership is handled. Overall, this is a good improvement to the documentation.

Comment on lines +147 to +148
/// let mut cur = std::io::Cursor::new(Vec::new());
/// let mut zip = ZipWriter::new(&mut cur);
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

This approach of passing a mutable reference to the Cursor is correct. However, an alternative and slightly more idiomatic approach would be to pass the Cursor by value, and then retrieve it from the result of zip.finish(). This makes the ownership transfer more explicit.

For example:

/// let writer = std::io::Cursor::new(Vec::new());
/// let mut zip = ZipWriter::new(writer);
/// // ... write files ...
/// let writer = zip.finish()?;
/// let zip_bytes = writer.into_inner();

This is just a suggestion for a cleaner style; your current implementation is perfectly fine.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This does not seems to be OK as the writer is not available afterwards because it has been moved

Pr0methean
Pr0methean previously approved these changes Oct 8, 2025
@Pr0methean Pr0methean enabled auto-merge October 8, 2025 23:28
@Pr0methean Pr0methean added this pull request to the merge queue Oct 9, 2025
Merged via the queue into zip-rs:master with commit eb1b586 Oct 9, 2025
65 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update zipwrite documentation example

2 participants