RFC-6213: Options API #6213
Merged
RFC-6213: Options API #6213
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
Signed-off-by: Xuanwo <[email protected]>
dosubot
bot
added
size:L
4 tasks
There was a problem hiding this comment.
Pull Request Overview
This PR proposes an RFC to introduce an options-based API for OpenDAL operations to improve code readability and maintainability.
- Introduces a new RFC document outlining the options API design.
- Provides code examples contrasting the traditional builder pattern with the proposed structured options approach.
Comments suppressed due to low confidence (2)
core/src/docs/rfcs/0000_options_api.md:91
- The 'version' field is used in the ReadOptions initialization but is not declared in the ReadOptions struct. Consider either adding the 'version' field to the struct or removing its usage from this example.
version: Some(version_id),
core/src/docs/rfcs/0000_options_api.md:92
- The code uses ReadOptions::default(), which implies that a default implementation exists for ReadOptions; however, such an implementation is not shown in the struct definition. Please include a default implementation or adjust the example accordingly.
...ReadOptions::default(),
Signed-off-by: Xuanwo <[email protected]>
asukaminato0721
approved these changes
May 22, 2025
jorgehermo9
approved these changes
May 22, 2025
This was referenced May 26, 2025
This was referenced Jun 3, 2025
This was referenced Jun 11, 2025
This was referenced Dec 26, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
Which issue does this PR close?
Closes #5727
Rationale for this change
Propose a new API to make our users lives easier.
What changes are included in this PR?
A new RFC.
Are there any user-facing changes?
None