docs: document the StreamStatus variants - #202
Merged
Merged
Conversation
|
@Yerimahjr Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
Yerimahjr
force-pushed
the
docs/issue-150
branch
from
August 30, 2026 13:54
ac4b26e to
e2c506b
Compare
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
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.
Summary
Closes #150. Documents each
StreamStatusvariant with the exact condition it represents, matching the logic instatus().Changes
Pending/Streaming/Completed: doc comments now state the precise ledger-time boundary (start_time,end_time) instead of loose phrasing.Cancelled: doc comment now states how it interacts with the time-based variants —status()checkscancelledbefore any time comparison, so once a stream is cancelled it reportsCancelledpermanently regardless of ledger time. Also notes cancellation can only happen fromPendingorStreaming, sincecancel()rejects oncenow >= end_time.Scope
Comment-only change in
contracts/stream/src/types.rs. No logic, tests, or public API touched.Test results
cargo fmt --check— cleancargo clippy --all-targets -- -D warnings— cleancargo test— 105 passed, 0 failed, 0 ignored