oxidecomputer / oxidecomputer/steno
Consider a `must_use` attribute on `SagaResult`
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 170
- Forks
- 15
- PR merge metrics
- No merged PRs in 30d
Description
SagaResult describes the result of executing a saga, akin to Rust's native Result type:
This type is propagated back to the SecClient, where it may be acquired when awaiting the future returned from saga_create.
As this is the only mechanism for actually checking the success or failure of a saga, we should consider annotating it with the must_use attribute.
Note that this would align with the stdlib Result type attribute, which uses must_use to encourage callers to handle errors explicitly.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with SagaResult in src/saga_exec.rs around lines 1407-1415, then compare the standard library Result definition linked in the issue. Confirm that the attribute applies to the propagated saga result and that ignoring it produces the intended compiler diagnostic; done means SagaResult encourages callers to check saga success or failure.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- distributed-systems
- Issue type
- Feature
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 50/100