-
Notifications
You must be signed in to change notification settings - Fork 96
docs: Update zip_writer documentation example #431
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
Conversation
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
Summary of ChangesHello @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 Highlights
Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this 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.
| /// let mut cur = std::io::Cursor::new(Vec::new()); | ||
| /// let mut zip = ZipWriter::new(&mut cur); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
There was a problem hiding this comment.
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
Signed-off-by: Chris Hennick <[email protected]>
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