codewide: Decrease excessive visibility from pub - breaking changes
#774
Conversation
This file contains 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
It's only intended to be used by the driver's code. Disclaimer: nothing has prevented users from calling this function, so this is a breaking change. It is, however, hardly probable that anybody would be using it directly in their code, so the change shouldn't hurt.
Both `RunQueryResult` and `AllowedRunQueryResTType` are internal abstractions of the driver and should not be exposed. Disclaimer: this is a breaking change, as the types were exposed. I can't think of a useful way of utilising them, though, so nobody should be hurt.
`ReplicaLocator` is intended to be exclusively constructed by the driver's code. It is hence no use `new()` being `pub`. Disclaimer: this is a breaking change, as one could have called the method. I can't think of any reason for doing that, though, so let's hope nobody is hurt.
`Metadata` serves the mere purpose of keeping the metadata together until it gets incorporated into `ClusterData`. It it at no point visible to the user by any public interface, so we can unpub it. Disclaimer: this is a breaking change, as the type was reachable from outside. I can't think of a useful way of utilising it, though, so nobody should be hurt.
`ShardInfo` is a container for sharding data fetched from a node. It does not provide any functionality that could be useful for the user (it is `Sharder` who does), so it's no point in keeping it exposed. Disclaimer: this is a breaking change.
havaker
approved these changes
Aug 3, 2023
avelanarius
approved these changes
Aug 18, 2023
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.
In spirit of the referenced issue,
scyllacrate is saved from the hazardous siege ofpubqualifiers. This PR collects the changes that I believe to be API-breaking. These changes, however, seem to be relatively benign.Refs: #660
Pre-review checklist
[ ] I added relevant tests for new features and bug fixes.[ ] I have provided docstrings for the public items that I want to introduce.[ ] I have adjusted the documentation in./docs/source/.[ ] I added appropriateFixes:annotations to PR description.