65 built in error transformations for generic errors

[noamteyssier]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @noamteyssier, 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 refines the error handling within the binseq crate by introducing a more flexible and standardized approach to managing generic errors. It allows for seamless conversion of standard library errors into the crate's custom Error enum, thereby improving the robustness and usability of error reporting throughout the library.

Highlights

• Enhanced Error Handling: A new GenericError variant has been added to the Error enum, allowing for the conversion of any type implementing std::error::Error (aliased as StdError) into the crate's custom error type. This significantly broadens the types of errors that can be handled uniformly.
• New Error Conversion Trait: A new trait, IntoBinseqError, has been introduced. This trait provides a standardized method (into_binseq_error) to convert various error types into the binseq::Error::GenericError, simplifying error propagation and integration.
• Public API Exposure: The newly created IntoBinseqError trait is now publicly exported from the lib.rs module, making it available for users of the binseq crate to leverage its enhanced error conversion capabilities.

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 a new GenericError variant and an IntoBinseqError trait to make it easier to convert arbitrary errors into the library's Error type. This is a positive change for the library's ergonomics. My review focuses on improving the documentation for these new additions to ensure clarity and maintainability, particularly regarding the distinction between the new GenericError and the existing AnyhowError.

[gemini-code-assist]

The documentation for GenericError is identical to AnyhowError, which could be confusing for users of your library. It's important to clarify the distinction between these two generic error types. For instance, you could explain that GenericError is intended as a general-purpose wrapper for any standard error, while AnyhowError is for specific integration with the anyhow crate's ecosystem.

Clarifying this will help developers understand when to use each variant. You might also consider whether both are necessary in the long term or if one should be preferred.

Suggested change

	/// Generic errors for other unexpected situations
	/// A generic wrapper for any type that implements `std::error::Error + Send + Sync`.

[gemini-code-assist]

The documentation comment refers to BinseqError, but the actual type is named Error. For better clarity and to leverage rustdoc's linking capabilities, it's best to use the correct type name and link to it.

Suggested change

	/// Trait for converting arbitrary errors into `BinseqError`
	/// Trait for converting arbitrary errors into [`Error`]