Rename ConfigReader.withSnapshot(_:) to ConfigReader.snapshot() #79
Conversation
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
FranzBusch
approved these changes
Nov 24, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Motivation
Fixes #78.
Since ConfigSnapshotReader is being sent through async sequences, we can't take advantage of any non-copyable/non-escapable optimizations on it, which brings the ConfigReader.withSnapshot method into question - why is it a with-style method, when simply returning a snapshot reader would work just fine? ConfigProvider.snapshot() already has this spelling.
This benefits consistency, because there isn't any reason the ConfigSnapshotReader needs to be scoped, this API shape came from an earlier experiment where we thought we could use a non-copyable/non-escapable type. But right now it's not providing any benefits and is just providing a slightly less ergonomic API for users.
Modifications
Renamed
ConfigReader.withSnapshot(_:)toConfigReader.snapshot().Result
More consistent, simpler API.
Test Plan
All tests pass.