feat: Add support for per-file comments by gmlewis · Pull Request #543 · zip-rs/zip2

gmlewis · 2026-01-22T18:46:38Z

Note that the changes in:

benches/read_metadata.rs
src/read.rs

were made to make cargo clippy happy.

Fixes: #542.

gemini-code-assist · 2026-01-22T18:46:56Z

Summary of Changes

Hello @gmlewis, I'm Gemini Code Assist¹! 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 introduces a significant enhancement by enabling the inclusion of per-file comments within ZIP archives. This feature provides a more granular way to attach descriptive metadata to individual entries, improving the overall utility and information richness of generated ZIP files. The changes involve extending the ZipWriter API and updating internal data structures to support this new capability, along with minor code quality improvements.

Highlights

New Feature: Per-File Comments: Introduced the ability to add comments to individual files within a ZIP archive, enhancing metadata capabilities.
API Additions: Added new public methods start_file_with_comment and start_file_from_path_with_comment to ZipWriter for creating files with associated comments.
Internal Logic Updates: Modified the internal start_entry function to accept an optional file comment and updated ZipFileData::is_ascii to consider the file comment.
Clippy Fixes and Lifetime Adjustments: Applied changes to benches/read_metadata.rs and src/read.rs to satisfy cargo clippy warnings and refined lifetime parameters in make_reader.
New Test Coverage: Added a new test case write_file_comment_roundtrip to ensure the correct functionality of writing and reading per-file comments.

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
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

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.

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. ↩

gemini-code-assist

Code Review

The pull request successfully introduces support for per-file comments, which is a valuable addition. The implementation correctly handles comment storage, length validation, and UTF-8 flagging. The new start_file_with_comment and start_file_from_path_with_comment methods provide a clear API for this feature, and the accompanying test case ensures its functionality. The lifetime adjustments in src/read.rs and the is_ascii update in src/types.rs are also good improvements.

benches/read_metadata.rs

src/read.rs

src/types.rs

src/write.rs

Pr0methean

I like the implementation of this PR, but the API needs a rework.

src/write.rs

benches/read_metadata.rs

gmlewis · 2026-01-23T23:15:56Z

Thank you, @Pr0methean and @Its-Just-Nans!
I believe I've addressed your feedback.
Please take another look when you get a chance.

Pr0methean

Thanks; just one nitpick.

src/write.rs

Pr0methean

Changing clone() to to_owned() won't help; see my inline comment.

src/write.rs

Review consisted of 1 suggestion that was applied.

Co-authored-by: n4n5 <git@n4n5.dev> Signed-off-by: Glenn Lewis <6598971+gmlewis@users.noreply.github.com>

Signed-off-by: Glenn Lewis <6598971+gmlewis@users.noreply.github.com>

…d in some configurations Signed-off-by: Chris Hennick <4961925+Pr0methean@users.noreply.github.com>

Signed-off-by: Chris Hennick <4961925+Pr0methean@users.noreply.github.com>

…ead of hyphens

gmlewis changed the title ~~feat: Add support for per-file comments (#1)~~ feat: Add support for per-file comments Jan 22, 2026

gemini-code-assist bot reviewed Jan 22, 2026

View reviewed changes

Pr0methean requested changes Jan 22, 2026

View reviewed changes

src/write.rs Outdated Show resolved Hide resolved

src/write.rs Outdated Show resolved Hide resolved

Pr0methean added this to the 7.3.0 milestone Jan 22, 2026

Its-Just-Nans previously requested changes Jan 23, 2026

View reviewed changes

benches/read_metadata.rs Outdated Show resolved Hide resolved

Pr0methean requested changes Jan 23, 2026

View reviewed changes

src/write.rs Outdated Show resolved Hide resolved

Pr0methean requested changes Jan 24, 2026

View reviewed changes

src/write.rs Outdated Show resolved Hide resolved

Pr0methean previously approved these changes Jan 24, 2026

View reviewed changes

Pr0methean enabled auto-merge January 24, 2026 03:22

Pr0methean dismissed their stale review via 4ad4bd9 January 24, 2026 03:46

Pr0methean force-pushed the gmlewis-master branch from 59747c3 to 808e546 Compare January 25, 2026 01:28

gmlewis and others added 11 commits January 25, 2026 12:42

feat: Add support for per-file comments (#1)

46e18c3

Update benches/read_metadata.rs

179afcd

Co-authored-by: n4n5 <git@n4n5.dev> Signed-off-by: Glenn Lewis <6598971+gmlewis@users.noreply.github.com>

Address review feedback

e000392

Signed-off-by: Glenn Lewis <6598971+gmlewis@users.noreply.github.com>

Address review feedback

6eb2282

Signed-off-by: Glenn Lewis <6598971+gmlewis@users.noreply.github.com>

Address review feedback

8ca9dfd

Signed-off-by: Glenn Lewis <6598971+gmlewis@users.noreply.github.com>

Fix: write_file_comment_roundtrip needs to override compression_metho…

b393361

…d in some configurations Signed-off-by: Chris Hennick <4961925+Pr0methean@users.noreply.github.com>

Update write.rs: fix comment syntax

4a3acb9

Signed-off-by: Chris Hennick <4961925+Pr0methean@users.noreply.github.com>

style: cargo fmt

9e2e04f

test: Fix another test that needs a compression_method override

38c10cc

Fix: feature names in cfg attributes incorrectly had underscores inst…

b507e91

…ead of hyphens

test: Fix build error

7702749

Pr0methean force-pushed the gmlewis-master branch from 808e546 to 7702749 Compare January 25, 2026 20:45

Pr0methean added 4 commits January 25, 2026 20:15

Merge branch 'master' into gmlewis-master

f33f53b

Merge branch 'master' into gmlewis-master

4694f12

Merge branch 'master' into gmlewis-master

4a4e0bd

Merge branch 'master' into gmlewis-master

cf96232

Merge branch 'master' into gmlewis-master

b835dc1

Pr0methean added this pull request to the merge queue Jan 28, 2026

Merged via the queue into zip-rs:master with commit 4f95817 Jan 28, 2026
126 checks passed

Pr0methean mentioned this pull request Jan 28, 2026

chore: release v7.3.0 #580

Merged

gmlewis deleted the gmlewis-master branch January 28, 2026 14:12

Conversation

gmlewis commented Jan 22, 2026

Uh oh!

gemini-code-assist bot commented Jan 22, 2026

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Pr0methean left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gmlewis commented Jan 23, 2026

Uh oh!

Pr0methean left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Pr0methean left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants