refactor(iroh-blobs, iroh)!: deprecate flat stores #2629
Merged
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.
Description
In the vein of promoting doing things TheRightWay™, this PR deprecates flat stores for their removal in a later iroh version. This is probably a low stakes deprecation and removal but imo gets us in the flow of being kind(er) with our users. Issue #2630 is created as a reminder to remove this.
Breaking Changes
iroh_blobs::store::fs::Store::import_flat_store
is deprecated. Ensure all data is migrated before future versions, which won't support this.iroh_blobs::store::fs::FlatStorePaths
is deprecated. Ensure all data is migrated before future versions, which won't support this.iroh
: Flat stores are deprecated. Ensure all data is migrated before future versions, which won't support this.Notes & open questions
n/a
Change checklist
Documentation updates following the style guide, if relevant.Tests if relevant.