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 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
//! Fast lexical conversion routines. //! //! Fast lexical conversion routines for both std and no_std environments. //! Lexical provides routines to convert numbers to and from decimal //! strings. Lexical also supports non-base 10 numbers, for both integers //! and floats. Lexical is simple to use, and exports only 6 functions //! in the high-level API. //! //! Lexical heavily uses unsafe code for performance, and therefore may //! introduce memory-safety issues. Although the code is tested with //! wide variety of inputs to minimize the risk of memory-safety bugs, //! no guarantees are made and you should use it at your own risk. // FEATURES // Require intrinsics and alloc in a no_std context. #![cfg_attr(not(feature = "std"), no_std)] #![cfg_attr(not(feature = "std"), feature(core_intrinsics))] #![cfg_attr(feature = "alloc", feature(alloc))] // EXTERNAL #[macro_use] extern crate cfg_if; // CONFIG cfg_if! { // Require alloc and use wee_alloc as the default allocator for unittesting. if #[cfg(all(feature = "alloc", not(feature = "std")))] { extern crate alloc; extern crate wee_alloc; #[global_allocator] static ALLOC: wee_alloc::WeeAlloc = wee_alloc::WeeAlloc::INIT; } } // Testing assertions for floating-point equality. #[cfg(test)] #[macro_use] extern crate approx; // Ensure only one back-end is enabled. #[cfg(all(feature = "grisu3", feature = "ryu"))] compile_error!("Lexical only accepts one of the following backends: `grisu3` or `ryu`."); // Import the back-end, if applicable. cfg_if! { if #[cfg(feature = "grisu3")] { extern crate dtoa; } else if #[cfg(feature = "ryu")] { extern crate ryu; } } /// Facade around the core features for name mangling. pub(crate) mod sealed { cfg_if! { if #[cfg(feature = "std")] { pub use std::*; } else { pub use core::*; } } } // API // Hide the implementation details. #[macro_use] mod util; // Publicly export the low-level APIs. // Macros used in atoi are required for atof, so export those. #[macro_use] #[doc(hidden)] pub mod table; #[macro_use] pub mod atoi; pub mod atof; pub mod ftoa; pub mod itoa; #[doc(hidden)] pub mod traits; // Re-export EXPONENT_DEFAULT_CHAR and EXPONENT_BACKUP_CHAR globally. pub use util::{EXPONENT_DEFAULT_CHAR, EXPONENT_BACKUP_CHAR}; // Re-export NAN_STRING and INFINITY_STRING globally. pub use util::{INFINITY_STRING, NAN_STRING}; // HIGH LEVEL use sealed::convert::AsRef; #[cfg(all(feature = "alloc", not(feature = "std")))] pub use alloc::string::String; use traits::Aton; #[cfg(any(feature = "std", feature = "alloc"))] use traits::Ntoa; /// High-level conversion of a number to a decimal-encoded string. /// /// * `n` - Number to convert to string. /// /// # Examples /// /// ```rust /// # extern crate lexical; /// # pub fn main() { /// assert_eq!(lexical::to_string(5), "5"); /// assert_eq!(lexical::to_string(0.0), "0.0"); /// # } /// ``` #[inline(always)] #[cfg(any(feature = "std", feature = "alloc"))] pub fn to_string<N: Ntoa>(n: N) -> String { n.serialize_to_string(10) } /// High-level conversion of a number to string with a custom radix. /// /// * `n` - Number to convert to string. /// * `base` - Number of unique digits for the number (radix). /// /// # Examples /// /// ```rust /// # extern crate lexical; /// # pub fn main() { /// assert_eq!(lexical::to_string_radix(5, 10), "5"); /// assert_eq!(lexical::to_string_radix(0.0, 10), "0.0"); /// # } /// ``` #[inline(always)] #[cfg(any(feature = "std", feature = "alloc"))] pub fn to_string_radix<N: Ntoa>(n: N, radix: u8) -> String { assert!(2 <= radix && radix <= 36, "to_string_radix, radix must be in range `[2, 36]`, got {}", radix); n.serialize_to_string(radix) } /// High-level conversion of decimal-encoded bytes to a number. /// /// This function **always** returns a number, parsing until invalid /// digits are found. For an error-checking version of this function, /// use [`try_parse`]. /// /// * `bytes` - Byte slice to convert to number. /// /// # Examples /// /// ```rust /// # extern crate lexical; /// # pub fn main() { /// // String overloads /// assert_eq!(lexical::parse::<i32, _>("5"), 5); /// assert_eq!(lexical::parse::<i32, _>("1a"), 1); /// assert_eq!(lexical::parse::<f32, _>("0"), 0.0); /// assert_eq!(lexical::parse::<f32, _>("1."), 1.0); /// assert_eq!(lexical::parse::<f32, _>("1.0"), 1.0); /// /// // Bytes overloads /// assert_eq!(lexical::parse::<i32, _>(b"5"), 5); /// assert_eq!(lexical::parse::<i32, _>(b"1a"), 1); /// assert_eq!(lexical::parse::<f32, _>(b"0"), 0.0); /// assert_eq!(lexical::parse::<f32, _>(b"1."), 1.0); /// assert_eq!(lexical::parse::<f32, _>(b"1.0"), 1.0); /// # } /// ``` /// /// [`try_parse`]: fn.try_parse.html #[inline(always)] pub fn parse<N: Aton, Bytes: AsRef<[u8]>>(bytes: Bytes) -> N { N::deserialize_from_bytes(bytes.as_ref(), 10) } /// High-level conversion of bytes to a number with a custom radix. /// /// This function **always** returns a number, parsing until invalid /// digits are found. For an error-checking version of this function, /// use [`try_parse_radix`]. /// /// * `bytes` - Byte slice to convert to number. /// * `radix` - Number of unique digits for the number (base). /// /// # Examples /// /// ```rust /// # extern crate lexical; /// # pub fn main() { /// // String overloads /// assert_eq!(lexical::parse_radix::<i32, _>("5", 10), 5); /// assert_eq!(lexical::parse_radix::<i32, _>("1a", 10), 1); /// assert_eq!(lexical::parse_radix::<f32, _>("0", 10), 0.0); /// assert_eq!(lexical::parse_radix::<f32, _>("1.", 10), 1.0); /// assert_eq!(lexical::parse_radix::<f32, _>("1.0", 10), 1.0); /// /// // Bytes overloads /// assert_eq!(lexical::parse_radix::<i32, _>(b"5", 10), 5); /// assert_eq!(lexical::parse_radix::<i32, _>(b"1a", 10), 1); /// assert_eq!(lexical::parse_radix::<f32, _>(b"0", 10), 0.0); /// assert_eq!(lexical::parse_radix::<f32, _>(b"1.", 10), 1.0); /// assert_eq!(lexical::parse_radix::<f32, _>(b"1.0", 10), 1.0); /// # } /// ``` /// /// [`try_parse_radix`]: fn.try_parse_radix.html #[inline(always)] pub fn parse_radix<N: Aton, Bytes: AsRef<[u8]>>(bytes: Bytes, radix: u8) -> N { assert!(2 <= radix && radix <= 36, "parse_radix, radix must be in range `[2, 36]`, got {}", radix); N::deserialize_from_bytes(bytes.as_ref(), radix) } /// High-level conversion of decimal-encoded bytes to a number. /// /// This function only returns a value if the entire string is /// successfully parsed. For an unchecked version of this function, /// use [`parse`]. /// /// * `bytes` - Byte slice to convert to number. /// /// # Examples /// /// ```rust /// # extern crate lexical; /// # pub fn main() { /// // String overloads /// assert_eq!(lexical::try_parse::<i32, _>("5"), Ok(5)); /// assert_eq!(lexical::try_parse::<i32, _>("1a"), Err(1)); /// assert_eq!(lexical::try_parse::<f32, _>("0"), Ok(0.0)); /// assert_eq!(lexical::try_parse::<f32, _>("1.0"), Ok(1.0)); /// assert_eq!(lexical::try_parse::<f32, _>("1."), Err(1)); /// /// // Bytes overloads /// assert_eq!(lexical::try_parse::<i32, _>(b"5"), Ok(5)); /// assert_eq!(lexical::try_parse::<i32, _>(b"1a"), Err(1)); /// assert_eq!(lexical::try_parse::<f32, _>(b"0"), Ok(0.0)); /// assert_eq!(lexical::try_parse::<f32, _>(b"1.0"), Ok(1.0)); /// assert_eq!(lexical::try_parse::<f32, _>(b"1."), Err(1)); /// # } /// ``` /// /// [`parse`]: fn.parse.html #[inline(always)] pub fn try_parse<N: Aton, Bytes: AsRef<[u8]>>(bytes: Bytes) -> Result<N, usize> { N::try_deserialize_from_bytes(bytes.as_ref(), 10) } /// High-level conversion of bytes to a number with a custom radix. /// /// This function only returns a value if the entire string is /// successfully parsed. For an unchecked version of this function, /// use [`parse_radix`]. /// /// * `bytes` - Byte slice to convert to number. /// * `radix` - Number of unique digits for the number (base). /// /// # Examples /// /// ```rust /// # extern crate lexical; /// # pub fn main() { /// // String overloads /// assert_eq!(lexical::try_parse_radix::<i32, _>("5", 10), Ok(5)); /// assert_eq!(lexical::try_parse_radix::<i32, _>("1a", 10), Err(1)); /// assert_eq!(lexical::try_parse_radix::<i32, _>("1.", 10), Err(1)); /// assert_eq!(lexical::try_parse_radix::<f32, _>("0", 10), Ok(0.0)); /// assert_eq!(lexical::try_parse_radix::<f32, _>("1.0", 10), Ok(1.0)); /// assert_eq!(lexical::try_parse_radix::<f32, _>("1.", 10), Err(1)); /// assert_eq!(lexical::try_parse_radix::<f32, _>("1.0.", 10), Err(3)); /// /// // Bytes overloads /// assert_eq!(lexical::try_parse_radix::<i32, _>(b"5", 10), Ok(5)); /// assert_eq!(lexical::try_parse_radix::<i32, _>(b"1a", 10), Err(1)); /// assert_eq!(lexical::try_parse_radix::<f32, _>(b"0", 10), Ok(0.0)); /// assert_eq!(lexical::try_parse_radix::<f32, _>(b"1.0", 10), Ok(1.0)); /// assert_eq!(lexical::try_parse_radix::<f32, _>(b"1.", 10), Err(1)); /// assert_eq!(lexical::try_parse_radix::<f32, _>(b"1.0.", 10), Err(3)); /// # } /// ``` /// /// [`parse_radix`]: fn.parse_radix.html #[inline(always)] pub fn try_parse_radix<N: Aton, Bytes: AsRef<[u8]>>(bytes: Bytes, radix: u8) -> Result<N, usize> { assert!(2 <= radix && radix <= 36, "try_parse_radix, radix must be in range `[2, 36]`, got {}", radix); N::try_deserialize_from_bytes(bytes.as_ref(), radix) }