lexical_util/
format.rs

1//! Public API for the number format packed struct.
2//!
3//! This has a consistent API whether or not the `format` feature is
4//! enabled, however, most functionality will be disabled if the feature
5//! is not enabled.
6//!
7//! # Pre-Defined Formats
8//!
9//! These are the pre-defined formats for parsing numbers from various
10//! programming, markup, and data languages.
11//!
12//! - [STANDARD]
13#![cfg_attr(feature = "format", doc = " - [`RUST_LITERAL`]")]
14#![cfg_attr(feature = "format", doc = " - [`RUST_STRING`]")]
15#![cfg_attr(feature = "format", doc = " - [`PYTHON_LITERAL`]")]
16#![cfg_attr(feature = "format", doc = " - [`PYTHON_STRING`]")]
17#![cfg_attr(feature = "format", doc = " - [`PYTHON3_LITERAL`]")]
18#![cfg_attr(feature = "format", doc = " - [`PYTHON3_STRING`]")]
19#![cfg_attr(feature = "format", doc = " - [`PYTHON36_LITERAL`]")]
20#![cfg_attr(feature = "format", doc = " - [`PYTHON35_LITERAL`]")]
21#![cfg_attr(feature = "format", doc = " - [`PYTHON2_LITERAL`]")]
22#![cfg_attr(feature = "format", doc = " - [`PYTHON2_STRING`]")]
23#![cfg_attr(feature = "format", doc = " - [`CXX_LITERAL`]")]
24#![cfg_attr(feature = "format", doc = " - [`CXX_STRING`]")]
25#![cfg_attr(all(feature = "format", feature = "power-of-two"), doc = " - [`CXX_HEX_LITERAL`]")]
26#![cfg_attr(all(feature = "format", feature = "power-of-two"), doc = " - [`CXX_HEX_STRING`]")]
27#![cfg_attr(feature = "format", doc = " - [`CXX20_LITERAL`]")]
28#![cfg_attr(feature = "format", doc = " - [`CXX20_STRING`]")]
29#![cfg_attr(all(feature = "format", feature = "power-of-two"), doc = " - [`CXX20_HEX_LITERAL`]")]
30#![cfg_attr(all(feature = "format", feature = "power-of-two"), doc = " - [`CXX20_HEX_STRING`]")]
31#![cfg_attr(feature = "format", doc = " - [`CXX17_LITERAL`]")]
32#![cfg_attr(feature = "format", doc = " - [`CXX17_STRING`]")]
33#![cfg_attr(all(feature = "format", feature = "power-of-two"), doc = " - [`CXX17_HEX_LITERAL`]")]
34#![cfg_attr(all(feature = "format", feature = "power-of-two"), doc = " - [`CXX17_HEX_STRING`]")]
35#![cfg_attr(feature = "format", doc = " - [`CXX14_LITERAL`]")]
36#![cfg_attr(feature = "format", doc = " - [`CXX14_STRING`]")]
37#![cfg_attr(all(feature = "format", feature = "power-of-two"), doc = " - [`CXX14_HEX_STRING`]")]
38#![cfg_attr(feature = "format", doc = " - [`CXX11_LITERAL`]")]
39#![cfg_attr(feature = "format", doc = " - [`CXX11_STRING`]")]
40#![cfg_attr(all(feature = "format", feature = "power-of-two"), doc = " - [`CXX11_HEX_STRING`]")]
41#![cfg_attr(feature = "format", doc = " - [`CXX03_LITERAL`]")]
42#![cfg_attr(feature = "format", doc = " - [`CXX03_STRING`]")]
43#![cfg_attr(feature = "format", doc = " - [`CXX98_LITERAL`]")]
44#![cfg_attr(feature = "format", doc = " - [`CXX98_STRING`]")]
45#![cfg_attr(feature = "format", doc = " - [`C_LITERAL`]")]
46#![cfg_attr(feature = "format", doc = " - [`C_STRING`]")]
47#![cfg_attr(all(feature = "format", feature = "power-of-two"), doc = " - [`C_HEX_LITERAL`]")]
48#![cfg_attr(all(feature = "format", feature = "power-of-two"), doc = " - [`C_HEX_STRING`]")]
49#![cfg_attr(feature = "format", doc = " - [`C18_LITERAL`]")]
50#![cfg_attr(feature = "format", doc = " - [`C18_STRING`]")]
51#![cfg_attr(all(feature = "format", feature = "power-of-two"), doc = " - [`C18_HEX_LITERAL`]")]
52#![cfg_attr(all(feature = "format", feature = "power-of-two"), doc = " - [`C18_HEX_STRING`]")]
53#![cfg_attr(feature = "format", doc = " - [`C11_LITERAL`]")]
54#![cfg_attr(feature = "format", doc = " - [`C11_STRING`]")]
55#![cfg_attr(all(feature = "format", feature = "power-of-two"), doc = " - [`C11_HEX_LITERAL`]")]
56#![cfg_attr(all(feature = "format", feature = "power-of-two"), doc = " - [`C11_HEX_STRING`]")]
57#![cfg_attr(feature = "format", doc = " - [`C99_LITERAL`]")]
58#![cfg_attr(feature = "format", doc = " - [`C99_STRING`]")]
59#![cfg_attr(all(feature = "format", feature = "power-of-two"), doc = " - [`C99_HEX_LITERAL`]")]
60#![cfg_attr(all(feature = "format", feature = "power-of-two"), doc = " - [`C99_HEX_STRING`]")]
61#![cfg_attr(feature = "format", doc = " - [`C90_LITERAL`]")]
62#![cfg_attr(feature = "format", doc = " - [`C90_STRING`]")]
63#![cfg_attr(all(feature = "format", feature = "power-of-two"), doc = " - [`C90_HEX_STRING`]")]
64#![cfg_attr(feature = "format", doc = " - [`C89_LITERAL`]")]
65#![cfg_attr(feature = "format", doc = " - [`C89_STRING`]")]
66#![cfg_attr(all(feature = "format", feature = "power-of-two"), doc = " - [`C89_HEX_STRING`]")]
67#![cfg_attr(feature = "format", doc = " - [`RUBY_LITERAL`]")]
68#![cfg_attr(all(feature = "format", feature = "power-of-two"), doc = " - [`RUBY_OCTAL_LITERAL`]")]
69#![cfg_attr(feature = "format", doc = " - [`RUBY_STRING`]")]
70#![cfg_attr(feature = "format", doc = " - [`SWIFT_LITERAL`]")]
71#![cfg_attr(feature = "format", doc = " - [`SWIFT_STRING`]")]
72#![cfg_attr(feature = "format", doc = " - [`GO_LITERAL`]")]
73#![cfg_attr(feature = "format", doc = " - [`GO_STRING`]")]
74#![cfg_attr(feature = "format", doc = " - [`HASKELL_LITERAL`]")]
75#![cfg_attr(feature = "format", doc = " - [`HASKELL_STRING`]")]
76#![cfg_attr(feature = "format", doc = " - [`JAVASCRIPT_LITERAL`]")]
77#![cfg_attr(feature = "format", doc = " - [`JAVASCRIPT_STRING`]")]
78#![cfg_attr(feature = "format", doc = " - [`PERL_LITERAL`]")]
79#![cfg_attr(feature = "format", doc = " - [`PERL_STRING`]")]
80#![cfg_attr(feature = "format", doc = " - [`PHP_LITERAL`]")]
81#![cfg_attr(feature = "format", doc = " - [`PHP_STRING`]")]
82#![cfg_attr(feature = "format", doc = " - [`JAVA_LITERAL`]")]
83#![cfg_attr(feature = "format", doc = " - [`JAVA_STRING`]")]
84#![cfg_attr(feature = "format", doc = " - [`R_LITERAL`]")]
85#![cfg_attr(feature = "format", doc = " - [`R_STRING`]")]
86#![cfg_attr(feature = "format", doc = " - [`KOTLIN_LITERAL`]")]
87#![cfg_attr(feature = "format", doc = " - [`KOTLIN_STRING`]")]
88#![cfg_attr(feature = "format", doc = " - [`JULIA_LITERAL`]")]
89#![cfg_attr(feature = "format", doc = " - [`JULIA_STRING`]")]
90#![cfg_attr(all(feature = "format", feature = "power-of-two"), doc = " - [`JULIA_HEX_LITERAL`]")]
91#![cfg_attr(all(feature = "format", feature = "power-of-two"), doc = " - [`JULIA_HEX_STRING`]")]
92#![cfg_attr(feature = "format", doc = " - [`CSHARP_LITERAL`]")]
93#![cfg_attr(feature = "format", doc = " - [`CSHARP_STRING`]")]
94#![cfg_attr(feature = "format", doc = " - [`CSHARP7_LITERAL`]")]
95#![cfg_attr(feature = "format", doc = " - [`CSHARP7_STRING`]")]
96#![cfg_attr(feature = "format", doc = " - [`CSHARP6_LITERAL`]")]
97#![cfg_attr(feature = "format", doc = " - [`CSHARP6_STRING`]")]
98#![cfg_attr(feature = "format", doc = " - [`CSHARP5_LITERAL`]")]
99#![cfg_attr(feature = "format", doc = " - [`CSHARP5_STRING`]")]
100#![cfg_attr(feature = "format", doc = " - [`CSHARP4_LITERAL`]")]
101#![cfg_attr(feature = "format", doc = " - [`CSHARP4_STRING`]")]
102#![cfg_attr(feature = "format", doc = " - [`CSHARP3_LITERAL`]")]
103#![cfg_attr(feature = "format", doc = " - [`CSHARP3_STRING`]")]
104#![cfg_attr(feature = "format", doc = " - [`CSHARP2_LITERAL`]")]
105#![cfg_attr(feature = "format", doc = " - [`CSHARP2_STRING`]")]
106#![cfg_attr(feature = "format", doc = " - [`CSHARP1_LITERAL`]")]
107#![cfg_attr(feature = "format", doc = " - [`CSHARP1_STRING`]")]
108#![cfg_attr(feature = "format", doc = " - [`KAWA_LITERAL`]")]
109#![cfg_attr(feature = "format", doc = " - [`KAWA_STRING`]")]
110#![cfg_attr(feature = "format", doc = " - [`GAMBITC_LITERAL`]")]
111#![cfg_attr(feature = "format", doc = " - [`GAMBITC_STRING`]")]
112#![cfg_attr(feature = "format", doc = " - [`GUILE_LITERAL`]")]
113#![cfg_attr(feature = "format", doc = " - [`GUILE_STRING`]")]
114#![cfg_attr(feature = "format", doc = " - [`CLOJURE_LITERAL`]")]
115#![cfg_attr(feature = "format", doc = " - [`CLOJURE_STRING`]")]
116#![cfg_attr(feature = "format", doc = " - [`ERLANG_LITERAL`]")]
117#![cfg_attr(feature = "format", doc = " - [`ERLANG_STRING`]")]
118#![cfg_attr(feature = "format", doc = " - [`ELM_LITERAL`]")]
119#![cfg_attr(feature = "format", doc = " - [`ELM_STRING`]")]
120#![cfg_attr(feature = "format", doc = " - [`SCALA_LITERAL`]")]
121#![cfg_attr(feature = "format", doc = " - [`SCALA_STRING`]")]
122#![cfg_attr(feature = "format", doc = " - [`ELIXIR_LITERAL`]")]
123#![cfg_attr(feature = "format", doc = " - [`ELIXIR_STRING`]")]
124#![cfg_attr(feature = "format", doc = " - [`FORTRAN_LITERAL`]")]
125#![cfg_attr(feature = "format", doc = " - [`FORTRAN_STRING`]")]
126#![cfg_attr(feature = "format", doc = " - [`D_LITERAL`]")]
127#![cfg_attr(feature = "format", doc = " - [`D_STRING`]")]
128#![cfg_attr(feature = "format", doc = " - [`COFFEESCRIPT_LITERAL`]")]
129#![cfg_attr(feature = "format", doc = " - [`COFFEESCRIPT_STRING`]")]
130#![cfg_attr(feature = "format", doc = " - [`COBOL_LITERAL`]")]
131#![cfg_attr(feature = "format", doc = " - [`COBOL_STRING`]")]
132#![cfg_attr(feature = "format", doc = " - [`FSHARP_LITERAL`]")]
133#![cfg_attr(feature = "format", doc = " - [`FSHARP_STRING`]")]
134#![cfg_attr(feature = "format", doc = " - [`VB_LITERAL`]")]
135#![cfg_attr(feature = "format", doc = " - [`VB_STRING`]")]
136#![cfg_attr(feature = "format", doc = " - [`OCAML_LITERAL`]")]
137#![cfg_attr(feature = "format", doc = " - [`OCAML_STRING`]")]
138#![cfg_attr(feature = "format", doc = " - [`OBJECTIVEC_LITERAL`]")]
139#![cfg_attr(feature = "format", doc = " - [`OBJECTIVEC_STRING`]")]
140#![cfg_attr(feature = "format", doc = " - [`REASONML_LITERAL`]")]
141#![cfg_attr(feature = "format", doc = " - [`REASONML_STRING`]")]
142#![cfg_attr(feature = "format", doc = " - [`OCTAVE_LITERAL`]")]
143#![cfg_attr(feature = "format", doc = " - [`OCTAVE_STRING`]")]
144#![cfg_attr(feature = "format", doc = " - [`MATLAB_LITERAL`]")]
145#![cfg_attr(feature = "format", doc = " - [`MATLAB_STRING`]")]
146#![cfg_attr(feature = "format", doc = " - [`ZIG_LITERAL`]")]
147#![cfg_attr(feature = "format", doc = " - [`ZIG_STRING`]")]
148#![cfg_attr(feature = "format", doc = " - [`SAGE_LITERAL`]")]
149#![cfg_attr(feature = "format", doc = " - [`SAGE_STRING`]")]
150#![cfg_attr(feature = "format", doc = " - [`JSON`]")]
151#![cfg_attr(feature = "format", doc = " - [`TOML`]")]
152#![cfg_attr(feature = "format", doc = " - [`YAML`]")]
153#![cfg_attr(feature = "format", doc = " - [`XML`]")]
154#![cfg_attr(feature = "format", doc = " - [`SQLITE`]")]
155#![cfg_attr(feature = "format", doc = " - [`POSTGRESQL`]")]
156#![cfg_attr(feature = "format", doc = " - [`MYSQL`]")]
157#![cfg_attr(feature = "format", doc = " - [`MONGODB`]")]
158//!
159//! # Syntax Flags
160//!
161//! Bitflags to get and set syntax flags for the format packed struct.
162//!
163//! - [`REQUIRED_INTEGER_DIGITS`]
164//! - [`REQUIRED_FRACTION_DIGITS`]
165//! - [`REQUIRED_EXPONENT_DIGITS`]
166//! - [`REQUIRED_MANTISSA_DIGITS`]
167//! - [`REQUIRED_DIGITS`]
168//! - [`NO_POSITIVE_MANTISSA_SIGN`]
169//! - [`REQUIRED_MANTISSA_SIGN`]
170//! - [`NO_EXPONENT_NOTATION`]
171//! - [`NO_POSITIVE_EXPONENT_SIGN`]
172//! - [`REQUIRED_EXPONENT_SIGN`]
173//! - [`NO_EXPONENT_WITHOUT_FRACTION`]
174//! - [`NO_SPECIAL`]
175//! - [`CASE_SENSITIVE_SPECIAL`]
176//! - [`NO_INTEGER_LEADING_ZEROS`]
177//! - [`NO_FLOAT_LEADING_ZEROS`]
178//! - [`REQUIRED_EXPONENT_NOTATION`]
179//! - [`CASE_SENSITIVE_EXPONENT`]
180//! - [`CASE_SENSITIVE_BASE_PREFIX`]
181//! - [`CASE_SENSITIVE_BASE_SUFFIX`]
182//!
183//! # Digit Separator Flags
184//!
185//! Bitflags to get and set digit separators flags for the format
186//! packed struct.
187//!
188//! - [`INTEGER_INTERNAL_DIGIT_SEPARATOR`]
189//! - [`FRACTION_INTERNAL_DIGIT_SEPARATOR`]
190//! - [`EXPONENT_INTERNAL_DIGIT_SEPARATOR`]
191//! - [`INTEGER_LEADING_DIGIT_SEPARATOR`]
192//! - [`FRACTION_LEADING_DIGIT_SEPARATOR`]
193//! - [`EXPONENT_LEADING_DIGIT_SEPARATOR`]
194//! - [`INTEGER_TRAILING_DIGIT_SEPARATOR`]
195//! - [`FRACTION_TRAILING_DIGIT_SEPARATOR`]
196//! - [`EXPONENT_TRAILING_DIGIT_SEPARATOR`]
197//! - [`INTEGER_CONSECUTIVE_DIGIT_SEPARATOR`]
198//! - [`FRACTION_CONSECUTIVE_DIGIT_SEPARATOR`]
199//! - [`EXPONENT_CONSECUTIVE_DIGIT_SEPARATOR`]
200//! - [`INTERNAL_DIGIT_SEPARATOR`]
201//! - [`LEADING_DIGIT_SEPARATOR`]
202//! - [`TRAILING_DIGIT_SEPARATOR`]
203//! - [`CONSECUTIVE_DIGIT_SEPARATOR`]
204//! - [`SPECIAL_DIGIT_SEPARATOR`]
205//!
206//! # Character Shifts and Masks
207//!
208//! Bitmasks and bit shifts to get and set control characters for the format
209//! packed struct.
210//!
211//! - [`DIGIT_SEPARATOR_SHIFT`]
212//! - [`DIGIT_SEPARATOR`]
213//! - [`BASE_PREFIX_SHIFT`]
214//! - [`BASE_PREFIX`]
215//! - [`BASE_SUFFIX_SHIFT`]
216//! - [`BASE_SUFFIX`]
217//! - [`MANTISSA_RADIX_SHIFT`]
218//! - [`MANTISSA_RADIX`]
219//! - [`RADIX_SHIFT`]
220//! - [`RADIX`]
221//! - [`EXPONENT_BASE_SHIFT`]
222//! - [`EXPONENT_BASE`]
223//! - [`EXPONENT_RADIX_SHIFT`]
224//! - [`EXPONENT_RADIX`]
225//!
226//! # Character Functions
227//!
228//! Functions to get control characters from the format packed struct.
229//!
230//! - [`digit_separator`]
231//! - [`base_prefix`]
232//! - [`base_suffix`]
233//! - [`mantissa_radix`]
234//! - [`exponent_base`]
235//! - [`exponent_radix`]
236//! - [`radix_from_flags`]
237//!
238//! # Validators
239//!
240//! Functions to validate control characters for the format packed struct.
241//!
242//! - [`is_valid_digit_separator`]
243//! - [`is_valid_base_prefix`]
244//! - [`is_valid_base_suffix`]
245//! - [`is_valid_punctuation`]
246//! - [`is_valid_radix`]
247
248use static_assertions::const_assert;
249
250use crate::error::Error;
251#[cfg(feature = "format")]
252pub use crate::feature_format::*;
253pub use crate::format_builder::*;
254pub use crate::format_flags::*;
255#[cfg(not(feature = "format"))]
256pub use crate::not_feature_format::*;
257
258/// Determine if the format packed struct is valid.
259#[inline(always)]
260pub const fn format_is_valid<const FORMAT: u128>() -> bool {
261    NumberFormat::<FORMAT> {}.is_valid()
262}
263
264/// Get the error type from the format packed struct.
265///
266/// An error type of `Error::Success` means the format is valid, any
267/// other error signifies an invalid format.
268#[inline(always)]
269pub const fn format_error<const FORMAT: u128>() -> Error {
270    NumberFormat::<FORMAT> {}.error()
271}
272
273/// Standard number format. This is identical to the Rust string format.
274pub const STANDARD: u128 = NumberFormatBuilder::new().build();
275const_assert!(NumberFormat::<{ STANDARD }> {}.is_valid());
lexical_util/format.rs

lexical_util/
format.rs
