String object, len is of type unsigned int, however indexOf() and lastIndexOf() return int

Open
#239 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
52/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Stale
Tech stack
cpp
Domain
api, embedded-iot

Research direction

Search the ArduinoCore-API String implementation for the indexOf() and lastIndexOf() declarations and implementations, then compare their return types with len, charAt(), substring(), remove(), and reserve(). Verify that both methods consistently use the intended unsigned type and that callers passing their results to substring() no longer require a cast.

Written by the indexing model from the issue text.

Description

bug
Description

String Object:

len is of type unsigned int.
method that apply to position into the String or its size are expecting an unsigned int, this is the case with:
charAt()
substring()
remove()
reserve()

Oddly, indexOf() and lastIndexOf() are returning int and not unsigned int

Current behavior

Oddly, indexOf() and lastIndexOf() are returning int and not unsigned int

Expected behavior

indexOf() and lastIndexOf() ought to return unsigned int, to avoid unnecessary casting from int to unsigned int

Additional information

It's frequent to pass the result of indexOf() to substring()

Thanks

Dominant language
C++
Stars
306
Forks
150
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

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.

More from arduino/ArduinoCore-API

All issues in arduino/ArduinoCore-API

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.