to-str 2.1.0

Efficient interface to convert value to it's textual representation
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
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
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
use crate::ToStr;

use core::{num, ptr};

//num % 100 * 2 + 1 at most will be 200, therefore DIGITS contains this much.
static DEC_DIGITS: &[u8; 200] = b"0001020304050607080910111213141516171819\
                                  2021222324252627282930313233343536373839\
                                  4041424344454647484950515253545556575859\
                                  6061626364656667686970717273747576777879\
                                  8081828384858687888990919293949596979899";
static HEX_DIGITS: [u8; 16] = [b'0', b'1', b'2', b'3', b'4', b'5', b'6', b'7', b'8', b'9', b'a', b'b', b'c', b'd', b'e', b'f'];
const PTR_PREFIX: [u8; 2] = [b'0', b'x'];

const fn size_of_val<T>(_: &T) -> usize {
    core::mem::size_of::<T>()
}

macro_rules! write_digit {
    ($buffer_ptr:ident[$cursor:ident] = $digit:expr) => {
        $cursor -= 1;
        unsafe {
            *$buffer_ptr.offset($cursor) = ($digit as u8) + b'0';
        }
    }
}

macro_rules! write_two_digits {
    ($buffer_ptr:ident[$cursor:ident] = $digits_ptr:ident[$digits_offset:expr]) => {

        $cursor -= 1;
        unsafe {
            *$buffer_ptr.offset($cursor) = *$digits_ptr.offset($digits_offset + 1);
        }

        $cursor -= 1;
        unsafe {
            *$buffer_ptr.offset($cursor) = *$digits_ptr.offset($digits_offset);
        }
    };
}

pub(crate) const unsafe fn write_u8_to_buf(mut num: u8, buffer_ptr: *mut u8, mut cursor: isize) -> isize {
    let digits_ptr = DEC_DIGITS.as_ptr();

    if num >= 100 {
        let index = (num as isize % 100) << 1;
        num /= 100;

        write_two_digits!(buffer_ptr[cursor] = digits_ptr[index]);
        write_digit!(buffer_ptr[cursor] = num);
    } else if num <= 9 {
        write_digit!(buffer_ptr[cursor] = num);
    } else {
        let index = num as isize * 2;

        write_two_digits!(buffer_ptr[cursor] = digits_ptr[index]);
    }

    cursor
}

pub(crate) const unsafe fn write_u64_to_buf(mut num: u64, buffer_ptr: *mut u8, mut cursor: isize) -> isize {
    let digits_ptr = DEC_DIGITS.as_ptr();

    while num >= 10000 {
        let rem = (num % 10000) as isize;
        num /= 10000;

        let index1 = (rem / 100) << 1;
        let index2 = (rem % 100) << 1;
        write_two_digits!(buffer_ptr[cursor] = digits_ptr[index2]);
        write_two_digits!(buffer_ptr[cursor] = digits_ptr[index1]);
    }

    if num >= 100 {
        let index = (num as isize % 100) << 1;
        num /= 100;

        write_two_digits!(buffer_ptr[cursor] = digits_ptr[index]);
    }

    if num < 10 {
        write_digit!(buffer_ptr[cursor] = num);
    } else {
        let index = num as isize * 2;

        write_two_digits!(buffer_ptr[cursor] = digits_ptr[index]);
    }

    cursor
}

//Taken from https://github.com/dtolnay/itoa for a better x128 divisions
//
//Ref: https://github.com/dtolnay/itoa/blob/3091ce69da35e9c8a8ff29702ea3310af30684e4/src/udiv128.rs#L1
#[inline(always)]
const fn udivmod_1e19(num: &mut u128) -> u64 {
    const DIV: u64 = 10_000_000_000_000_000_000;

    #[inline(always)]
    const fn u128_mulhi(x: u128, y: u128) -> u128 {
        let x_lo = x as u64;
        let x_hi = (x >> 64) as u64;
        let y_lo = y as u64;
        let y_hi = (y >> 64) as u64;

        // handle possibility of overflow
        let carry = (x_lo as u128 * y_lo as u128) >> 64;
        let m = x_lo as u128 * y_hi as u128 + carry;
        let high1 = m >> 64;

        let m_lo = m as u64;
        let high2 = (x_hi as u128 * y_lo as u128 + m_lo as u128) >> 64;

        x_hi as u128 * y_hi as u128 + high1 + high2
    }

    let quot = if *num < 1 << 83 {
        ((*num >> 19) as u64 / (DIV >> 19)) as u128
    } else {
        u128_mulhi(*num, 156927543384667019095894735580191660403) >> 62
    };

    let rem = (*num - quot * DIV as u128) as u64;
    *num = quot;

    rem
}

#[inline]
pub(crate) const unsafe fn write_u128_to_buf(mut num: u128, buffer_ptr: *mut u8, mut cursor: isize) -> isize {
    const U64_TEXT_MAX_WRITTEN: isize = u64::TEXT_SIZE as isize - 1;

    if num <= u64::MAX as u128 {
        //shortcut to directly calling u64 routine once
        unsafe {
            return write_u64_to_buf(num as u64, buffer_ptr, cursor)
        }
    }

    let first64 = udivmod_1e19(&mut num);
    if num <= u64::MAX as u128 {
        //Fill ahead of time to smooth
        unsafe {
            ptr::write_bytes(buffer_ptr.offset(cursor - U64_TEXT_MAX_WRITTEN), b'0', U64_TEXT_MAX_WRITTEN as _);
        }

        unsafe {
            write_u64_to_buf(first64, buffer_ptr, cursor);
        }
        //finish directly with u64 write since it fits
        unsafe {
            write_u64_to_buf(num as u64, buffer_ptr, cursor - U64_TEXT_MAX_WRITTEN)
        }
    } else {
        let second64 = udivmod_1e19(&mut num);

        //Fill ahead of time to smooth
        unsafe {
            ptr::write_bytes(buffer_ptr.offset(cursor - U64_TEXT_MAX_WRITTEN * 2), b'0', (U64_TEXT_MAX_WRITTEN * 2) as _);
        }

        unsafe {
            write_u64_to_buf(first64, buffer_ptr, cursor);
        }

        cursor -= U64_TEXT_MAX_WRITTEN;
        let written_cursor = unsafe {
            write_u64_to_buf(second64, buffer_ptr, cursor)
        };

        if num != 0 {
            cursor -= U64_TEXT_MAX_WRITTEN;
            // There is at most one digit left
            // because u128::max / 10^19 / 10^19 is 3.
            write_digit!(buffer_ptr[cursor] = num);
            cursor
        } else {
            written_cursor
        }
    }
}

const unsafe fn write_hex_to_buf(mut num: usize, buffer_ptr: *mut u8, mut cursor: isize) -> isize {
    const BASE: usize = 4;
    const BASE_DIGIT: usize = (1 << BASE) - 1;
    let digits_ptr = HEX_DIGITS.as_ptr();

    loop {
        let digit = num & BASE_DIGIT;
        cursor -= 1;
        unsafe {
            ptr::write(buffer_ptr.offset(cursor), *digits_ptr.add(digit));
        }
        num >>= BASE;

        if num == 0 {
            break;
        }
    }

    cursor
}

#[inline(always)]
pub(crate) const unsafe fn write_ptr_to_buf(num: usize, buffer_ptr: *mut u8, mut cursor: isize) -> isize {
    const PTR_PREFIX_SIZE: usize = size_of_val(&PTR_PREFIX);
    cursor = unsafe {
        write_hex_to_buf(num, buffer_ptr, cursor)
    };
    cursor -= PTR_PREFIX_SIZE as isize;

    unsafe {
        ptr::copy_nonoverlapping(PTR_PREFIX.as_ptr(), buffer_ptr.offset(cursor), PTR_PREFIX_SIZE);
    }

    cursor
}

macro_rules! impl_unsigned {
    ($t:ident: $max:expr; $conv:ident($($cv_t:tt)*)) => {
        #[inline]
        pub(crate) const fn $t(num: $t, buffer: &'_ mut [core::mem::MaybeUninit<u8>]) -> &'_ str {
            debug_assert!(buffer.len() >= <$t as crate::ToStr>::TEXT_SIZE);
            unsafe {
                let offset = super::$conv(num $($cv_t)*, buffer.as_mut_ptr() as *mut u8, buffer.len() as isize);
                let slice = core::slice::from_raw_parts(buffer.as_ptr().offset(offset) as *const u8, buffer.len() - offset as usize);
                core::str::from_utf8_unchecked(slice)
            }
        }

        unsafe impl crate::ToStr for $t {
            const TEXT_SIZE: usize = $max;

            #[inline(always)]
            fn to_str<'a>(&self, buffer: &'a mut [u8]) -> &'a str {
                let buffer = unsafe {
                    core::mem::transmute::<&'a mut [u8], &'a mut [core::mem::MaybeUninit<u8>]>(buffer)
                };
                $t(*self, buffer)
            }
        }
    }
}

pub mod unsigned {
    impl_unsigned!(u8: 3; write_u8_to_buf(as u8));
    impl_unsigned!(u16: 5; write_u64_to_buf(as u64));
    impl_unsigned!(u32: 10; write_u64_to_buf(as u64));
    impl_unsigned!(u64: 20; write_u64_to_buf(as u64));
    impl_unsigned!(u128: 39; write_u128_to_buf(as u128));

    pub(crate) const fn usize(num: usize, buffer: &'_ mut [core::mem::MaybeUninit<u8>]) -> &'_ str {
        debug_assert!(buffer.len() >= <usize as crate::ToStr>::TEXT_SIZE);
        unsafe {
            let offset = super::write_u64_to_buf(num as _, buffer.as_mut_ptr() as *mut u8, buffer.len() as isize);
            let slice = core::slice::from_raw_parts(buffer.as_ptr().offset(offset) as *const u8, buffer.len() - offset as usize);
            core::str::from_utf8_unchecked(slice)
        }
    }
}

unsafe impl ToStr for usize {
    #[cfg(target_pointer_width = "16")]
    const TEXT_SIZE: usize = <u16 as ToStr>::TEXT_SIZE;
    #[cfg(target_pointer_width = "32")]
    const TEXT_SIZE: usize = <u32 as ToStr>::TEXT_SIZE;
    #[cfg(target_pointer_width = "64")]
    const TEXT_SIZE: usize = <u64 as ToStr>::TEXT_SIZE;

    #[inline]
    fn to_str<'a>(&self, buffer: &'a mut [u8]) -> &'a str {
        let buffer = unsafe {
            core::mem::transmute::<&'a mut [u8], &'a mut [core::mem::MaybeUninit<u8>]>(buffer)
        };
        unsigned::usize(*self, buffer)
    }
}

macro_rules! impl_signed {
    ($t:ident as $st:ident where $conv:ident as $cv_t:ty) => {
        #[inline]
        pub(crate) const fn $t(num: $t, buffer: &'_ mut [core::mem::MaybeUninit<u8>]) -> &'_ str {
            if num.is_negative() {
                debug_assert!(buffer.len() >= <$t as crate::ToStr>::TEXT_SIZE);

                let abs = (0 as $st).wrapping_sub(num as $st);
                unsafe {
                    let offset = super::$conv(abs as $cv_t, buffer.as_mut_ptr() as *mut u8, buffer.len() as isize) - 1;
                    core::ptr::write(buffer.as_mut_ptr().offset(offset), core::mem::MaybeUninit::new(b'-'));
                    let slice = core::slice::from_raw_parts(buffer.as_ptr().offset(offset) as *const u8, buffer.len() - offset as usize);
                    core::str::from_utf8_unchecked(slice)
                }

            } else {
                crate::numeric::unsigned::$st(num as $st, buffer)
            }
        }

        unsafe impl crate::ToStr for $t {
            const TEXT_SIZE: usize = <$st>::TEXT_SIZE + 1;

            #[inline(always)]
            fn to_str<'a>(&self, buffer: &'a mut [u8]) -> &'a str {
                let buffer = unsafe {
                    core::mem::transmute::<&'a mut [u8], &'a mut [core::mem::MaybeUninit<u8>]>(buffer)
                };
                $t(*self, buffer)
            }
        }
    }
}

pub mod signed {
    impl_signed!(i8 as u8 where write_u8_to_buf as u8);
    impl_signed!(i16 as u16 where write_u64_to_buf as u64);
    impl_signed!(i32 as u32 where write_u64_to_buf as u64);
    impl_signed!(i64 as u64 where write_u64_to_buf as u64);
    impl_signed!(i128 as u128 where write_u128_to_buf as u128);

    #[inline]
    pub(crate) const fn isize(num: isize, buffer: &'_ mut [core::mem::MaybeUninit<u8>]) -> &'_ str {
        if num.is_negative() {
            debug_assert!(buffer.len() >= <isize as crate::ToStr>::TEXT_SIZE);

            #[cfg(target_pointer_width = "16")]
            let abs = 0i16.wrapping_sub(num as i16);
            #[cfg(target_pointer_width = "32")]
            let abs = 0i32.wrapping_sub(num as i32);
            #[cfg(target_pointer_width = "64")]
            let abs = 0i64.wrapping_sub(num as i64);

            unsafe {
                let offset = super::write_u64_to_buf(abs as _, buffer.as_mut_ptr() as *mut u8, buffer.len() as isize) - 1;
                core::ptr::write(buffer.as_mut_ptr().offset(offset), core::mem::MaybeUninit::new(b'-'));
                let slice = core::slice::from_raw_parts(buffer.as_ptr().offset(offset) as *const u8, buffer.len() - offset as usize);
                core::str::from_utf8_unchecked(slice)
            }
        } else {
            super::unsigned::usize(num as _, buffer)
        }
    }
}

unsafe impl ToStr for isize {
    #[cfg(target_pointer_width = "16")]
    const TEXT_SIZE: usize = <i16 as ToStr>::TEXT_SIZE;
    #[cfg(target_pointer_width = "32")]
    const TEXT_SIZE: usize = <i32 as ToStr>::TEXT_SIZE;
    #[cfg(target_pointer_width = "64")]
    const TEXT_SIZE: usize = <i64 as ToStr>::TEXT_SIZE;

    #[inline(always)]
    fn to_str<'a>(&self, buffer: &'a mut [u8]) -> &'a str {

        let buffer = unsafe {
            core::mem::transmute::<&'a mut [u8], &'a mut [core::mem::MaybeUninit<u8>]>(buffer)
        };
        signed::isize(*self, buffer)
    }
}

unsafe impl<T> ToStr for *const T {
    const TEXT_SIZE: usize = usize::TEXT_SIZE + 2;

    #[inline]
    fn to_str<'a>(&self, buffer: &'a mut [u8]) -> &'a str {
        debug_assert!(buffer.len() >= Self::TEXT_SIZE);

        unsafe {
            let offset = write_ptr_to_buf(*self as usize, buffer.as_mut_ptr(), buffer.len() as isize) as usize;
            core::str::from_utf8_unchecked(&buffer[offset..])
        }
    }
}

unsafe impl<T> ToStr for *mut T {
    const TEXT_SIZE: usize = usize::TEXT_SIZE + 2;

    #[inline(always)]
    fn to_str<'a>(&self, buffer: &'a mut [u8]) -> &'a str {
        (*self as *const T).to_str(buffer)
    }
}

unsafe impl<T> ToStr for core::sync::atomic::AtomicPtr<T> {
    const TEXT_SIZE: usize = usize::TEXT_SIZE + 2;

    #[inline(always)]
    fn to_str<'a>(&self, buffer: &'a mut [u8]) -> &'a str {
        self.load(core::sync::atomic::Ordering::Acquire).to_str(buffer)
    }
}

unsafe impl<T> ToStr for ptr::NonNull<T> {
    const TEXT_SIZE: usize = usize::TEXT_SIZE + 2;

    #[inline(always)]
    fn to_str<'a>(&self, buffer: &'a mut [u8]) -> &'a str {
        self.as_ptr().to_str(buffer)
    }
}

macro_rules! impl_non_zero_repr {
    ($($t:ty: $repr:ty);* $(;)?) => {
        $(
        unsafe impl ToStr for $t {
            const TEXT_SIZE: usize = {
                assert!(core::mem::size_of::<$t>() == core::mem::size_of::<$repr>(), "NonZero type doesn't match Repr type");
                <$repr as ToStr>::TEXT_SIZE
            };

            #[inline(always)]
            fn to_str<'a>(&self, buffer: &'a mut [u8]) -> &'a str {
                ToStr::to_str(&(*self).get(), buffer)
            }
        }
        )*
    }
}

impl_non_zero_repr!(
    num::NonZeroU8: u8;
    num::NonZeroU16: u16;
    num::NonZeroU32: u32;
    num::NonZeroU64: u64;
    num::NonZeroU128: u128;
    num::NonZeroUsize: usize;

    num::NonZeroI8: i8;
    num::NonZeroI16: i16;
    num::NonZeroI32: i32;
    num::NonZeroI64: i64;
    num::NonZeroI128: i128;
    num::NonZeroIsize: isize;
);