Improve Documentation on ObjectStoreExt
#551
Conversation
src/lib.rs
Outdated
| /// ) -> Result<Vec<Bytes>> { | ||
| /// ... | ||
| /// } | ||
| /// There are no default implementation for any of the methods in this trait by |
There was a problem hiding this comment.
This is not true (yet) but I believe that the goal for 0.13.0 is to remove all default implementations -- @crepererum can you confirm this is the plan / goal?
There was a problem hiding this comment.
That's not gonna happen for 0.13, e.g. list_prefixes and get_ranges will still have default impls. I don't think we gonna remove them in 0.13, since they cannot easily be mapped to _opts methods either.
There was a problem hiding this comment.
Ok, I will revise this wording
Co-authored-by: Kyle Barron <kylebarron2@gmail.com>
…-object-store into alamb/ObjectStoreExt_docs
| /// and the store users and provides additional methods that may be simpler to use but overlap | ||
| /// in functionality with [`ObjectStore`]. | ||
| /// | ||
| /// # Wrappers |
There was a problem hiding this comment.
I think the wrappers section is still relevant. In fact NOT using the clippy lint is still a foot gun (#537 proofs that even object_store itself suffered from this and we had a wide range of cases at Influx too).
|
Thank you @crepererum and @kylebarron for the help reviewing this |
3 participants
Which issue does this PR close?
ObjectStoretrait: Split out convenience methods #385Rationale for this change
One major API change in the next
object_storerelease is the addition of theObjectStoreExttraitand the removal of several APIs from
ObjectStoreintoObjectStoreExt.This will be a breaking change for downstream users of
object_storeso it is importantthat we have good documentation about the rationale for hte change (and what they get out of the change)
and how to migrate to the new APIs.
What changes are included in this PR?
Add some documentation to the
object_storecrate root and to theObjectStoreExttrait itselfAre there any user-facing changes?
Yes more docs