Skip to content

fix: add missing lifetimes#684

Merged
samueltardieu merged 1 commit intomainfrom
push-rnryzltwnust
Jun 13, 2025
Merged

fix: add missing lifetimes#684
samueltardieu merged 1 commit intomainfrom
push-rnryzltwnust

Conversation

@samueltardieu
Copy link
Copy Markdown
Member

@samueltardieu samueltardieu commented Jun 13, 2025

Summary by CodeRabbit

  • Refactor
    • Improved clarity of method signatures by specifying explicit lifetimes for iterator return types in several public methods. No changes to functionality or user experience.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Jun 13, 2025

Walkthrough

The changes update the return types of several public iterator methods in the Grid and Matrix implementations to explicitly include lifetime annotations. This ensures that the returned iterators are clearly tied to the lifetime of the borrowed struct instances, improving type clarity and compiler checks. No internal logic or control flow was modified.

Changes

File(s) Change Summary
src/grid.rs Updated edges() and iter() method signatures in Grid to return iterators with explicit lifetimes.
src/matrix.rs Updated values() and values_mut() method signatures in Matrix to return iterators with lifetimes.

Poem

A rabbit with code so precise,
Tweaked lifetimes to make things concise.
Now iterators borrow just right,
No lifetime confusion in sight!
With every hop and every bound,
The safest code is what we’ve found.
🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2a9b27e and eba465e.

📒 Files selected for processing (2)
  • src/grid.rs (2 hunks)
  • src/matrix.rs (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
src/matrix.rs (1)
tests/matrix.rs (2)
  • values (740-746)
  • values_mut (749-756)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: benchmarks
🔇 Additional comments (4)
src/matrix.rs (2)

643-645: Return type of values annotated with explicit lifetime
Including Iter<'_, C> makes the borrow scope clear and matches the expected behavior.


648-650: Return type of values_mut annotated with explicit lifetime
Changing to IterMut<'_, C> correctly ties the mutable iterator’s lifetime to &mut self.

src/grid.rs (2)

336-336: Explicit lifetime on edges iterator return
Updating to EdgesIterator<'_> clarifies that the iterator borrows from &self.


445-445: Explicit lifetime on iter method return
Specifying GridIterator<'_> correctly binds the iterator’s lifetime to the grid reference.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@samueltardieu samueltardieu added this pull request to the merge queue Jun 13, 2025
Merged via the queue into main with commit 8508470 Jun 13, 2025
14 checks passed
@samueltardieu samueltardieu deleted the push-rnryzltwnust branch June 13, 2025 20:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant