feat(iroh)!: make blobs::read_at more flexible #2756
Merged
Conversation
This file contains 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
Introduces `ReadAtLen` which allows to specify the behaviour of `read_at` more closely - `All` - reads until the end (formerly `None`) - `Exact(size)` - Reads exactly this many bytes (formerly `Some(size)` - `AtMost(size)` - Reads at most this many bytes, but allows for a shorter response if not enough data is available Closes #2738 ## Breaking Changes - `iroh::client::Blobs::read_at` and `read_at_to_bytes` now take `ReadAtLen` instead of `Option<usize>`
rklaehn
approved these changes
Sep 30, 2024
| @@ -159,7 +159,7 @@ impl Client { | |||
| /// Read offset + len from a single blob. | |||
| /// | |||
| /// If `len` is `None` it will read the full blob. | |||
| pub async fn read_at(&self, hash: Hash, offset: u64, len: Option<usize>) -> Result<Reader> { | |||
| pub async fn read_at(&self, hash: Hash, offset: u64, len: ReadAtLen) -> Result<Reader> { | |||
There was a problem hiding this comment.
I like using an enum, but for the public API can we maybe do something with a From conversion so that you can still provide just a length?
So this would be fn read_at(&self, hash: Hash, offset: u64, len: impl Into<ReadAtLen>) and you would implement From for ReadAtLen to map to Exact?
There was a problem hiding this comment.
I don't want to do this, because i think it is confusing/not clear if the into behaviour will be exact or at_most.
dignifiedquire
changed the title
|
Documentation for this PR has been generated and is available at: https://n0-computer.github.io/iroh/pr/2756/docs/iroh/ Last updated: 2024-09-30T12:43:55Z |
matheus23
pushed a commit
that referenced
this pull request
Nov 14, 2024
Introduces `ReadAtLen` which allows to specify the behaviour of `read_at` more closely - `All` - reads until the end (formerly `None`) - `Exact(size)` - Reads exactly this many bytes (formerly `Some(size)` - `AtMost(size)` - Reads at most this many bytes, but allows for a shorter response if not enough data is available Closes #2738 ## Breaking Changes - `iroh::client::Blobs::read_at` and `read_at_to_bytes` now take `ReadAtLen` instead of `Option<usize>` --------- Co-authored-by: Asmir Avdicevic <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Introduces
ReadAtLenwhich allows to specify the behaviour ofread_atmore closelyAll- reads until the end (formerlyNone)Exact(size)- Reads exactly this many bytes (formerlySome(size)AtMost(size)- Reads at most this many bytes, but allows for a shorter response if not enough data is availableCloses #2738
Breaking Changes
iroh::client::Blobs::read_atandread_at_to_bytesnow takeReadAtLeninstead ofOption<usize>