Document TrinoInput contract #27160
Merged
Document TrinoInput contract #27160
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
findepi
added
the
no-release-notes
This comment was marked as off-topic.
This comment was marked as off-topic.
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
wendigo
reviewed
Oct 30, 2025
lib/trino-filesystem/src/main/java/io/trino/filesystem/TrinoInput.java
Outdated
Show resolved
Hide resolved
wendigo
reviewed
Oct 30, 2025
lib/trino-filesystem/src/main/java/io/trino/filesystem/TrinoInput.java
Outdated
Show resolved
Hide resolved
wendigo
reviewed
Oct 30, 2025
lib/trino-filesystem/src/main/java/io/trino/filesystem/TrinoInput.java
Outdated
Show resolved
Hide resolved
wendigo
approved these changes
Oct 30, 2025
findepi
force-pushed
the
findepi/document-trinoinput-contract-62e9aa
branch
2 times, most recently
from
b0b769b to
a64bfd7
Compare
| * | ||
| * @param buffer the buffer to read bytes into; must be non-null | ||
| * @param bufferOffset the offset in the buffer to start writing bytes to; must be non-negative | ||
| * @param maxLength the maximum number of bytes to read; must be non-negative |
Member
There was a problem hiding this comment.
Is maxLength allowed to be bigger than remaining space in buffer ?
Member
Author
There was a problem hiding this comment.
i think it's not allowed
| * | ||
| * @param buffer the buffer to read bytes into; must be non-null | ||
| * @param bufferOffset the offset in the buffer to start writing bytes to; must be non-negative | ||
| * @param maxLength the maximum number of bytes to read; must be non-negative |
Member
There was a problem hiding this comment.
Is maxLength allowed to be bigger than file size ?
Member
Author
There was a problem hiding this comment.
for readTail - i think it is allowed
| * @param maxLength the maximum number of bytes to read; must be non-negative | ||
| * @return the number of bytes actually read, which may be less than {@code maxLength} if | ||
| * the input contains fewer bytes than {@code maxLength} | ||
| */ |
Member
Author
There was a problem hiding this comment.
omitted intentionally, i have no information to add beyond what's already in the method signature
wendigo
reviewed
Oct 30, 2025
lib/trino-filesystem/src/main/java/io/trino/filesystem/TrinoInput.java
Outdated
Show resolved
Hide resolved
findepi
force-pushed
the
findepi/document-trinoinput-contract-62e9aa
branch
from
a64bfd7 to
026398b
Compare
raunaqmorarka
approved these changes
Oct 30, 2025
findepi
force-pushed
the
findepi/document-trinoinput-contract-62e9aa
branch
from
026398b to
e673a7e
Compare
chenjian2664
approved these changes
Oct 31, 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.
Summary by Sourcery
Document the behavior and error contracts for TrinoInput’s readFully and readTail methods
Enhancements: