Remove the useless mutable reference for ActionClient#63
Closed
drindr wants to merge 0 commit intoAtostek:masterfrom
Closed
Remove the useless mutable reference for ActionClient#63drindr wants to merge 0 commit intoAtostek:masterfrom
drindr wants to merge 0 commit intoAtostek:masterfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR improves the API design of ActionClient by changing the accessor methods from returning mutable references (&mut) to immutable references (&). Since the underlying Client and Subscription types use interior mutability and expose methods that take &self, the mutable references were unnecessary and overly restrictive for API consumers.
- Changed five accessor methods in
ActionClientto return immutable references - Updated example code to reflect that
ActionClientno longer needs to be mutable
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/action/client.rs | Changed goal_client(), cancel_client(), result_client(), feedback_subscription(), and status_subscription() methods to return immutable references instead of mutable references |
| examples/turtle_teleop/main.rs | Removed mut keyword from rotate_action_client variable declaration since mutable access is no longer required |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Thanks for your nice crate.
Finding that to access the service or topic in the ActionClient, a mutable reference of ActionClient is required, I think it is totally unnecessary. It is almost impossible to modify them in other crate because most of the related methods are
pub(crate)even private. Removing the &mut can make external design easier as well.