MatMoore / MatMoore/string-inspector

DecodedString::decode should not fail

Open
#10 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted
Dominant language
Rust
Stars
3
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Currently this returns a `Result`. But we're giving it the `Replace` DecoderTrap, so it should be able to continue processing in the event of an error. Is this the case?

If so, we should unwrap this and simplify the API.

See also: https://github.com/MatMoore/string-inspector/issues/6

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the DecodedString::decode entry point and inspect how the Replace DecoderTrap is passed to decoding. Check the related issue #6 for context, then determine whether error recovery makes the Result unnecessary. Done means the API decision is confirmed and covered by the relevant tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
cli
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.