Performance improvements - new return types in rust

[MusicalNinjaDad]

Rust 4.0.0 & Python 3.0.1

• BREAKING CHANGES - Rust: new return types for significant performance improvements:
  • MultiFizzBuzz now lazily returns a rayon IndexedParallelIterator
  • FizzBuzz returns a FizzBuzzAnswer which can be converted into a String or Cow<str>
  • FizzBuzzAnswer now represents the valid answers to FizzBuzz, not One(String)or Many(Vec>String>)
• Python implementation updated to work with rust v4.0.0 which brings slight performance improvements (approx 10-20%)

Summary by Sourcery

This pull request introduces significant performance improvements by updating the return types for FizzBuzz and MultiFizzBuzz. The FizzBuzzAnswer enum has been refactored to directly represent valid FizzBuzz answers. The Python implementation has been updated to work with Rust v4.0.0, bringing slight performance improvements. Documentation and tests have been updated accordingly.

• New Features:
  • Introduced new return types for FizzBuzz and MultiFizzBuzz to improve performance, including lazy evaluation with rayon::iter::IndexedParallelIterator.
• Enhancements:
  • Updated FizzBuzzAnswer to represent valid FizzBuzz answers directly, removing the need for One(String) and Many(Vec<String>) variants.
  • Enhanced the Python implementation to work with Rust v4.0.0, resulting in slight performance improvements (approx 10-20%).
• Documentation:
  • Updated documentation to reflect new return types and usage examples for FizzBuzz and MultiFizzBuzz.
• Tests:
  • Added new tests to cover the updated FizzBuzzAnswer and MultiFizzBuzz implementations, including tests for negative numbers and non-whole numbers.
  • Updated existing tests to use the new return types and ensure compatibility with the new implementation.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request introduces significant performance improvements by changing the return types in the Rust implementation of the FizzBuzz library. The MultiFizzBuzz trait now returns a lazy rayon::iter::IndexedParallelIterator, and the FizzBuzz function returns a FizzBuzzAnswer enum, which can be converted into a String or Cow<str>. The Python implementation has also been updated to work with Rust v4.0.0, resulting in slight performance improvements (approximately 10-20%).

File-Level Changes

Files	Changes
rust/fizzbuzz/src/lib.rs rust/fizzbuzz/tests/test_numbertypes.rs rust/fizzbuzz/tests/test_multifizzbuzz.rs	Updated Rust implementation to use new return types for performance improvements and updated corresponding tests.
rust/fizzbuzzo3/src/lib.rs tests/perf_results.md	Updated Python wrapper and added performance results for new return types.
rust/fizzbuzz/benches/bench_fizzbuzz.rs rust/fizzbuzz/benches/bench_sizes.rs	Updated benchmarks to reflect new return types and added new benchmarks for Cow<str>.

---

Tips

• Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
• You can change your review settings at any time by accessing your dashboard:
  • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
  • Change the review language;
• You can always contact us if you have any questions or feedback.

[codecov]

Codecov Report

Attention: Patch coverage is 94.33962% with 3 lines in your changes missing coverage. Please review.

Files	Patch %	Lines
rust/fizzbuzz/src/lib.rs	90.62%	3 Missing ⚠️

Additional details and impacted files

Flag	Coverage Δ
fizzbuzz	94.64% <90.62%> (+0.79%)	⬆️
fizzbuzzo3	90.52% <81.25%> (+3.02%)	⬆️
python	100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

📢 Thoughts on this report? Let us know!

[sourcery-ai]

Hey @MusicalNinjaDad - I've reviewed your changes and they look great!

Here's what I looked at during the review

• 🟡 General issues: 7 issues found
• 🟢 Security: all looks good
• 🟡 Testing: 3 issues found
• 🟢 Complexity: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.}

[sourcery-ai]

suggestion (testing): Add tests for boundary values

It would be useful to add tests for boundary values such as 0, 1, and the maximum values for each type to ensure the new return types handle these correctly.