exint 0.1.4

An implementation of generic signed and unsigned integers.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169

//! Library Errors

use ::core::convert::From;
use ::core::convert::Infallible;
use ::core::error::Error;
use ::core::fmt::Display;
use ::core::fmt::Formatter;
use ::core::fmt::Result;

// -----------------------------------------------------------------------------
// TryFromCharError
// -----------------------------------------------------------------------------

/// The error type returned when a checked char conversion fails.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct TryFromCharError(());

impl TryFromCharError {
  #[inline]
  pub(crate) const fn new() -> Self {
    Self(())
  }
}

impl Display for TryFromCharError {
  fn fmt(&self, f: &mut Formatter<'_>) -> Result {
    f.write_str("unicode code point out of range")
  }
}

impl Error for TryFromCharError {}

// -----------------------------------------------------------------------------
// TryFromIntError
// -----------------------------------------------------------------------------

/// The error type returned when a checked integral type conversion fails.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct TryFromIntError(());

impl TryFromIntError {
  #[inline]
  pub(crate) const fn new() -> Self {
    Self(())
  }
}

impl Display for TryFromIntError {
  fn fmt(&self, f: &mut Formatter<'_>) -> Result {
    f.write_str("out of range integral type conversion attempted")
  }
}

impl Error for TryFromIntError {}

const_trait_if! {
  #[feature("const_convert")]
  impl const From<Infallible> for TryFromIntError {
    fn from(other: Infallible) -> Self {
      match other {}
    }
  }

  #[feature("const_convert")]
  #[cfg(feature = "never_type")]
  impl const From<!> for TryFromIntError {
    fn from(other: !) -> Self {
      match other {}
    }
  }
}

// -----------------------------------------------------------------------------
// IntErrorKind
// -----------------------------------------------------------------------------

/// Enum to store the various types of errors that can cause parsing an integer to fail.
///
/// # Examples
///
/// ```should_panic
/// use exint::primitive::i32;
///
/// if let Err(e) = i32::from_str_radix("a12", 10) {
///     panic!("Failed conversion to int: {:?}", e.kind());
/// }
/// ```
#[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)]
#[non_exhaustive]
pub enum IntErrorKind {
  /// Value being parsed is empty.
  ///
  /// This variant will be constructed when parsing an empty string.
  Empty,
  /// Contains an invalid digit in its context.
  ///
  /// Among other causes, this variant will be constructed when parsing a string
  /// that contains a non-ASCII char.
  ///
  /// This variant is also constructed when a `+` or `-` is misplaced within a
  /// string either on its own or in the middle of a number.
  InvalidDigit,
  /// Integer is too large to store in target integer type.
  PosOverflow,
  /// Integer is too small to store in target integer type.
  NegOverflow,
}

// -----------------------------------------------------------------------------
// ParseIntError
// -----------------------------------------------------------------------------

/// An error which can be returned when parsing an integer.
///
/// This error is used as the error type for the `from_str_radix()` functions on
/// the generic integer types, such as [`int::from_str_radix`] and is used as
/// the error type in their [`FromStr`] implementations.
///
/// # Potential causes
///
/// Among other causes, `ParseIntError` can be thrown because of leading or
/// trailing whitespace in the string e.g., when it is obtained from the
/// standard input. Using the [`str::trim()`] method ensures that no whitespace
/// remains before parsing.
///
/// # Examples
///
/// ```should_panic
/// use exint::primitive::i32;
///
/// if let Err(e) = i32::from_str_radix("a12", 10) {
///     panic!("Failed conversion to int: {e}");
/// }
/// ```
///
/// [`int::from_str_radix`]: crate::int::from_str_radix
/// [`FromStr`]: ::core::str::FromStr
///
#[expect(missing_copy_implementations, reason = "")]
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct ParseIntError {
  kind: IntErrorKind,
}

impl ParseIntError {
  #[inline]
  pub(crate) const fn new(kind: IntErrorKind) -> Self {
    Self { kind }
  }

  /// Outputs the detailed cause of parsing an integer failing.
  #[must_use]
  pub const fn kind(&self) -> &IntErrorKind {
    &self.kind
  }
}

impl Display for ParseIntError {
  fn fmt(&self, f: &mut Formatter<'_>) -> Result {
    match self.kind {
      IntErrorKind::Empty => f.write_str("cannot parse integer from empty string"),
      IntErrorKind::InvalidDigit => f.write_str("invalid digit found in string"),
      IntErrorKind::PosOverflow => f.write_str("number too large to fit in target type"),
      IntErrorKind::NegOverflow => f.write_str("number too small to fit in target type"),
    }
  }
}

impl Error for ParseIntError {}