rust-lang / rust-lang/libs-team
Expose `FloatErrorKind` from private `core::num::dec2flt` to public `core::num::FloatErrorKind`
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 178
- Forks
- 28
- Avg merge
- 15m
- Merged PRs (30d)
- 1
Description
Proposal
Problem statement
core::num::ParseIntError can expose its kind via:
impl ParseIntError {
/// Outputs the detailed cause of parsing an integer failing.
#[must_use]
#[rustc_const_stable(feature = "const_int_from_str", since = "1.82.0")]
#[stable(feature = "int_error_matching", since = "1.55.0")]
pub const fn kind(&self) -> &IntErrorKind {
&self.kind
}
}
However, core::num::ParseFloatError cannot expose its kind. Neither a kind method nor the FloatErrorKind enum is publicly available.
This is unnecessary unalignment IMO, so I propose to expose FloatErrorKind and add ParseFloatError::kind method.
Motivating examples or use cases
Described as above. I have a personal project that handle these two errors:
impl From<ParseIntError> for ErrorKind {
fn from(err: ParseIntError) -> Self {
ErrorKind::Other(match err.kind() {
IntErrorKind::InvalidDigit => ...,
IntErrorKind::PosOverflow => ...,
IntErrorKind::NegOverflow => ...,
_ => ...,
})
}
}
impl From<ParseFloatError> for ErrorKind {
fn from(err: ParseFloatError) -> Self {
ErrorKind::Other(match err.kind() { /* compile error, no `kind` method and the kind enum is private */})
}
}
Solution sketch
- Mark
core::num::dec2flt::FloatErrorKindaspub, properly expose it cascadingly tocore::num. - Add
ParseFloatError::kindto expose the error kind, just asParseIntError::kinddoes.
Alternatives
N/A
Links and related work
What happens now?
This issue contains an API change proposal (or ACP) and is part of the libs-api team feature lifecycle. Once this issue is filed, the libs-api team will review open proposals as capability becomes available. Current response times do not have a clear estimate, but may be up to several months.
Possible responses
The libs team may respond in various different ways. First, the team will consider the problem (this doesn't require any concrete solution or alternatives to have been proposed):
- We think this problem seems worth solving, and the standard library might be the right place to solve it.
- We think that this probably doesn't belong in the standard library.
Second, if there's a concrete solution:
- We think this specific solution looks roughly right, approved, you or someone else should implement this. (Further review will still happen on the subsequent implementation PR.)
- We're not sure this is the right solution, and the alternatives or other materials don't give us enough information to be sure about that. Here are some questions we have that aren't answered, or rough ideas about alternatives we'd want to see discussed.
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 by reading the linked issue #22639 and the standard library feature lifecycle before attempting implementation. Review core::num::dec2flt::FloatErrorKind, core::num, and ParseFloatError::kind as named in the proposal. Done means the public enum and accessor have an accepted API design and are exposed consistently with ParseIntError::kind.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100