index: organize Index and IndexStore errors into enums #7799
+58
−68
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
This way we match how errors are organized for the other storage traits, and we allow for networked implementations of `Index::all_heads_for_gc` to return I/O errors.
This way we match how the errors are organized for other storage traits.
By using a type alias, we match how `Backend` and `OpStore` traits organize their errors. This will be useful as we progressively convert more methods on `Index`, `MutableIndex`, `ReadonlyIndex`, and `ChangeIdIndex` traits to return `Result<T, IndexError>` in order to support networked implementations which can produce I/O failures.
By introducing `IndexStoreResult`, we follow the pattern used by other storage traits: `BackendResult`, `OpStoreResult`, and `IndexResult`.
bts
force-pushed
the
bts/index-error-enums
branch
from
c46f909 to
ed307f1
Compare
martinvonz
approved these changes
Oct 22, 2025
|
@bts: In case you missed it, I invited you to the contributors team yesterday |
|
Great -- thank you, Martin! |
This was referenced Oct 23, 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.
Ahead of subsequent changes to convert more methods on
Index,MutableIndex,ReadonlyIndex, andChangeIdIndexto be fallible, these four changes:IndexandIndexStore's disparate error types intoenums like other storage traits (e.g.BackendError,OpStoreError).IndexResulttype alias (like those ofBackendResultandOpStoreResult) that will help as more index trait methods are made fallible. We introduceIndexStoreResultwhile we're at it, for symmetry with the other storage trait result types.By making
IndexErroranenumand returning that fromIndex::all_heads_for_gc, we allow for network-based implementations of this method to produce arbitrary I/O errors in addition to the existing case ofAllHeadsForGcUnsupported.Let me know if there's anything I should change -- e.g. drop the
IndexStoreResultalias, submit one PR per change, etc.Thanks!
Brian
Checklist
If applicable:
CHANGELOG.mdREADME.md,docs/,demos/)cli/src/config-schema.json)