Return immutable List instead of SnapshotStateList from toEntries

[Daiji256]

What I have done and why

This PR changes toEntries to return an immutable List instead of SnapshotStateList.

Mutating the returned list does not affect NavigationState, so exposing a mutable state list may be misleading.

There is no functional behavior change.

Similar change: android/nav3-recipes#234

[gemini-code-assist]

Summary of Changes

Hello @Daiji256, 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 API of the NavigationState by modifying the toEntries extension function. The primary goal is to enhance API clarity and prevent potential misuse by returning an immutable List type. This ensures that any attempts to modify the returned collection will not inadvertently suggest a change to the underlying navigation state, as such mutations would have no effect. The change improves the robustness and predictability of the API without introducing any behavioral differences.

Highlights

• API Clarity: The toEntries function now returns an immutable List instead of a SnapshotStateList to prevent misleading external mutations that do not affect the internal NavigationState.
• Immutability: The change promotes immutability in the API contract, ensuring that consumers of the toEntries function receive a collection that cannot be modified externally, aligning with the internal state's behavior.
• No Functional Change: This modification is purely an API contract change and does not alter the functional behavior of the NavigationState or how entries are managed internally.

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

Changelog

• core/navigation/src/main/kotlin/com/google/samples/apps/nowinandroid/core/navigation/NavigationState.kt
  • Removed imports for SnapshotStateList and toMutableStateList.
  • Updated the return type of the toEntries extension function from SnapshotStateList<NavEntry<NavKey>> to List<NavEntry<NavKey>>.
  • Removed the .toMutableStateList() call from the toEntries function's return statement.

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 correctly changes the toEntries function to return an immutable List instead of a SnapshotStateList. This is a valuable improvement as it makes the API contract clearer and prevents consumers from attempting to mutate a list that doesn't affect the underlying navigation state. The changes are well-implemented, including the removal of unused imports and the conversion call, leading to cleaner and more robust code.