microsoft / microsoft/inflatelib
Simplify the driver interface
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 11
- Forks
- 4
- Avg merge
- 4h 17m
- Merged PRs (30d)
- 1
Description
Consider the abstract state machine and there are four states:
- Waiting for further input
- Waiting for further output
- Stream has been processed successfully.
- Stream has been processed unsuccessfully.
Those states should be reflected in the exit codes of the inflate driver function. That simplifies the logic for caller as well as it avoids most address calculations to see which state the library is currently in.
Contributor guide
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 by locating the inflate driver function and its callers, then map the four states described in the issue to the current interface behavior. Define completion as callers being able to distinguish waiting for input, waiting for output, successful completion, and unsuccessful completion through exit codes, with the surrounding state and address-calculation logic simplified accordingly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100