Draft: iterable zip

[Its-Just-Nans]

I think the zip crate should go toward an iterable zip instead of storing every files in memory, since this can lead to memory issue

could fix #486
could fix #488
could fix #240

Example usage of this MR

fn main() {
    let reader = std::fs::File::open("submissions.zip").unwrap();
    let mut zip = zip::read::IterableZipArchive::try_new(reader, Config::default()).unwrap();
    println!("{}", std::mem::size_of_val(&zip));

    for file in zip.files().unwrap() {
        let file = file.unwrap();
        println!("Read file: {}", file.file_name);
    }
}

State of this MR: drafting since I think the iter should be more part of zip crate

[gemini-code-assist]

Summary of Changes

Hello @Its-Just-Nans, 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 an iterable interface for reading zip archives, enhancing the library's usability by allowing developers to easily iterate over the files contained within a zip. It provides a new IterableZipArchive struct that wraps the underlying reader and exposes an IterableShared iterator, simplifying the process of accessing individual file metadata without needing to manually manage file pointers or indices.

Highlights

• New IterableZipArchive: Introduced a new IterableZipArchive struct that provides an iterable interface for reading zip archives, allowing for easier processing of files within.
• IterableShared Implementation: Added the IterableShared struct, which manages the underlying reader and directory information, and implements the Iterator trait to yield ZipFileData entries sequentially.
• Idiomatic Iteration: This change enables a more idiomatic Rust approach to access files in a zip archive, allowing users to iterate over files directly using a for loop.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

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.

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

[gemini-code-assist]

Code Review

This pull request introduces an IterableZipArchive, a new way to read ZIP archives by iterating over file entries instead of loading them all into memory at once. This is a great addition for handling large archives efficiently.

My review focuses on improving the correctness and robustness of the new iterator implementation. I've suggested changes to make it a proper fallible iterator that correctly handles the number of files and propagates errors, which is crucial for dealing with potentially corrupt archives. I also pointed out some unnecessary code that can be removed to improve clarity.

Overall, this is a valuable feature, and with these changes, it will be more robust and idiomatic.

[Pr0methean]

@Its-Just-Nans Is this ready for review? Because it's still marked as a draft.

[Its-Just-Nans]

@Its-Just-Nans Is this ready for review? Because it's still marked as a draft.

Hi

I think I still need to do more code like tests and examples with real life examples

Also one other benchmark

Maybe I will also rename the struct

So, no it's not review-ready for now ^^

[Pr0methean]

This may not be enough to fix #487, because it's unclear if the user needs random access (i.e. to keep using by_index rather than an iterator). See my comment there for how we might make by_index (and by_file_data) work in that case.