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
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
//! A nul-terminated string,which is just a pointer to the string data,
//! it doesn't know the length of the string.

#[cfg(test)]
mod tests;

use crate::std_types::RStr;

use const_panic::{concat_assert, concat_panic};

use std::{
    cmp::{Eq, Ord, Ordering, PartialEq, PartialOrd},
    fmt::{self, Debug, Display},
    marker::PhantomData,
    ptr::NonNull,
};

/// A utf8 nul-terminated immutable borrowed string.
///
/// For the purpose of passing `NulStr`s to C,
/// this has the same ABI as a `std::ptr::NonNull<u8>`,
/// and an `Option<NulStr<'_>>` has the same ABI as `*const u8`.
///
/// # Safety
///
/// `NulStr` has these safety requirement:
/// - the string must be valid to read for the `'a` lifetime
/// - the string must be utf8 encoded
/// - the string must be nul terminated
/// - the string must not be mutated while this is alive
/// (the same semantics as `&` references)
///
/// # Example
///
/// ### Passing to extern function
///
/// You can pass `NulStr` to C functions expecting a nul-terminated string.
///
/// ```rust
/// use abi_stable::sabi_types::NulStr;
///
/// extern "C" {
///     // the signature in the C side is `uint64_t add_digits(const char*)`
///     fn add_digits(_: NulStr<'_>) -> u64;
/// }
/// # #[export_name = "add_digits"]
/// # pub extern "C" fn add_digits___(str: NulStr<'_>) -> u64 {
/// #    str.to_str().bytes()
/// #    .filter_map(|x|{
/// #        match x {
/// #            b'0'..=b'9' => Some(u64::from(x - b'0')),
/// #            _ => None,
/// #        }
/// #    })
/// #    .sum()
/// # }
///
/// # fn main() {
/// const FOO: NulStr<'_> = NulStr::from_str("1.2.3\0");
/// const BAR: NulStr<'_> = NulStr::from_str("12|34\0");
/// const QUX: NulStr<'_> = NulStr::from_str("123_abcd_45\0");
///
/// assert_eq!(unsafe { add_digits(FOO) }, 6);
/// assert_eq!(unsafe { add_digits(BAR) }, 10);
/// assert_eq!(unsafe { add_digits(QUX) }, 15);
/// # }
/// ```
#[repr(transparent)]
#[derive(Copy, Clone, StableAbi)]
pub struct NulStr<'a> {
    ptr: NonNull<u8>,
    _marker: PhantomData<&'a u8>,
}

unsafe impl Sync for NulStr<'_> {}
unsafe impl Send for NulStr<'_> {}

impl NulStr<'static> {
    /// An empty string.
    pub const EMPTY: Self = NulStr::from_str("\0");
}

impl<'a> NulStr<'a> {
    /// Constructs an `NulStr` from a string slice.
    ///
    /// # Correctness
    ///
    /// If the string contains interior nuls,
    /// the first nul will be considered the string terminator.
    ///
    /// # Panics
    ///
    /// This panics when the string does not end with `'\0'`.
    ///
    /// # Example
    ///
    /// ```rust
    /// use abi_stable::sabi_types::NulStr;
    ///
    /// const FOO: NulStr<'_> = NulStr::from_str("foo\0");
    /// // `NulStr`s can be compared with `str`s
    /// assert_eq!(FOO, "foo");
    ///
    /// const BAR: NulStr<'_> = NulStr::from_str("bar\0");
    /// assert_eq!(BAR, "bar");
    ///
    /// const HEWWO: NulStr<'_> = NulStr::from_str("Hello, world!\0");
    /// assert_eq!(HEWWO, "Hello, world!");
    ///
    /// const TRUNCATED: NulStr<'_> = NulStr::from_str("baz\0world!\0");
    /// assert_eq!(TRUNCATED, "baz");
    ///
    /// ```
    pub const fn from_str(str: &'a str) -> Self {
        let this = Self {
            ptr: crate::utils::ref_as_nonnull(str).cast::<u8>(),
            _marker: PhantomData,
        };

        let last_byte = str.as_bytes()[str.len() - 1] as usize;
        concat_assert! {
            last_byte == 0,
            "expected a nul terminator, found:",
            last_byte,
        };
        this
    }

    /// Constructs an NulStr from a string slice.
    ///
    /// # Errors
    ///
    /// This returns a [`NulStrError::NoNulTerminator`] when the string does not end
    /// with `'\0'`.
    ///
    /// This returns a [`NulStrError::InnerNul`] when the string contains a
    /// `'\0'` before the `'\0'` terminator.
    ///
    /// # Example
    ///
    /// ```rust
    /// use abi_stable::sabi_types::{NulStr, NulStrError};
    ///
    /// // `NulStr`s can be compared with `str`s
    /// assert_eq!(NulStr::try_from_str("hello\0").unwrap(), "hello");
    ///
    /// assert_eq!(
    ///     NulStr::try_from_str("hello\0world\0"),
    ///     Err(NulStrError::InnerNul { pos: 5 }),
    /// );
    ///
    /// ```
    ///
    /// [`NulStrError::InnerNul`]: enum.NulStrError.html#variant.InnerNul
    /// [`NulStrError::NoNulTerminator`]: enum.NulStrError.html#variant.NoNulTerminator
    pub const fn try_from_str(string: &'a str) -> Result<Self, NulStrError> {
        let mut i = 0;
        let mut bytes = string.as_bytes();

        bytes = match bytes {
            [rem @ .., 0] => rem,
            _ => return Err(NulStrError::NoNulTerminator),
        };

        while let [b, ref rem @ ..] = *bytes {
            if b == 0 {
                return Err(NulStrError::InnerNul { pos: i });
            }
            i += 1;
            bytes = rem;
        }

        unsafe { Ok(NulStr::from_ptr(string.as_ptr())) }
    }

    #[doc(hidden)]
    #[track_caller]
    pub const fn __try_from_str_unwrapping(s: &'a str) -> Self {
        match Self::try_from_str(s) {
            Ok(x) => x,
            Err(NulStrError::InnerNul { pos }) => {
                concat_panic!("encountered inner nul byte at position: ", pos)
            }
            Err(NulStrError::NoNulTerminator) => concat_panic!("found no nul-terminator"),
        }
    }

    /// Constructs an NulStr from a pointer.
    ///
    /// # Safety
    ///
    /// [The same as the type-level safety docs](#safety)
    ///
    /// # Correctness
    ///
    /// If the string contains interior nuls,
    /// the first nul will be considered the string terminator.
    ///
    /// # Example
    ///
    /// ```rust
    /// use abi_stable::sabi_types::NulStr;
    ///
    /// const FOO: NulStr<'_> = unsafe { NulStr::from_ptr("foo\0".as_ptr()) };
    /// assert_eq!(FOO, "foo");
    ///
    /// const BAR: NulStr<'_> = unsafe { NulStr::from_ptr("bar\0".as_ptr()) };
    /// assert_eq!(BAR, "bar");
    ///
    /// const HEWWO: NulStr<'_> = unsafe { NulStr::from_ptr("Hello, world!\0".as_ptr()) };
    /// assert_eq!(HEWWO, "Hello, world!");
    ///
    /// const TRUNCATED: NulStr<'_> = unsafe { NulStr::from_ptr("baz\0world!\0".as_ptr()) };
    /// assert_eq!(TRUNCATED, "baz");
    ///
    /// ```
    pub const unsafe fn from_ptr(ptr: *const u8) -> Self {
        Self {
            ptr: unsafe { NonNull::new_unchecked(ptr as *mut u8) },
            _marker: PhantomData,
        }
    }

    /// Gets a pointer to the start of this nul-terminated string.
    ///
    /// # Example
    ///
    /// ```rust
    /// use abi_stable::sabi_types::NulStr;
    ///
    /// let foo_str = "foo\0";
    /// let foo = NulStr::from_str(foo_str);
    /// assert_eq!(foo.as_ptr(), foo_str.as_ptr());
    ///
    /// ```
    pub const fn as_ptr(self) -> *const u8 {
        self.ptr.as_ptr()
    }

    /// Converts this `NulStr<'a>` to a `&'a str`,including the nul byte.
    ///
    /// # Performance
    ///
    /// This conversion requires traversing through the entire string to
    /// find the nul byte.
    ///
    /// # Example
    ///
    /// ```rust
    /// use abi_stable::sabi_types::NulStr;
    ///
    /// const FOO: NulStr<'_> = NulStr::from_str("foo bar\0");
    /// let foo: &str = FOO.to_str_with_nul();
    /// assert_eq!(&foo[..3], "foo");
    /// assert_eq!(&foo[4..], "bar\0");
    ///
    /// ```
    pub fn to_str_with_nul(&self) -> &'a str {
        unsafe {
            let bytes = std::ffi::CStr::from_ptr(self.ptr.as_ptr() as *const _).to_bytes_with_nul();
            std::str::from_utf8_unchecked(bytes)
        }
    }

    /// Computes the length of the string, NOT including the nul terminator.
    #[cfg(feature = "rust_1_64")]
    const fn compute_length(self) -> usize {
        let start: *const u8 = self.ptr.as_ptr();
        let mut ptr = start;
        let mut len = 0;
        unsafe {
            while *ptr != 0 {
                ptr = ptr.offset(1);
                len += 1;
            }
            len
        }
    }

    /// Converts this `NulStr<'a>` to a `&'a str`,including the nul byte.
    ///
    /// # Performance
    ///
    /// To make this function const-callable,
    /// this uses a potentially less efficient approach than
    /// [`to_str_with_nul`](Self::to_str_with_nul).
    ///
    /// This conversion requires traversing through the entire string to
    /// find the nul byte.
    ///
    /// # Example
    ///
    /// ```rust
    /// use abi_stable::sabi_types::NulStr;
    ///
    /// const FOO: NulStr<'_> = NulStr::from_str("foo bar\0");
    /// const FOO_S: &str = FOO.const_to_str_with_nul();
    /// assert_eq!(&FOO_S[..3], "foo");
    /// assert_eq!(&FOO_S[4..], "bar\0");
    ///
    /// ```
    #[cfg(feature = "rust_1_64")]
    #[cfg_attr(feature = "docsrs", doc(cfg(feature = "rust_1_64")))]
    pub const fn const_to_str_with_nul(&self) -> &'a str {
        unsafe {
            let len = self.compute_length();
            std::str::from_utf8_unchecked(std::slice::from_raw_parts(self.as_ptr(), len + 1))
        }
    }

    /// Converts this `NulStr<'a>` to a `RStr<'a>`,including the nul byte.
    ///
    /// # Performance
    ///
    /// This conversion requires traversing through the entire string to
    /// find the nul byte.
    ///
    /// # Example
    ///
    /// ```rust
    /// use abi_stable::sabi_types::NulStr;
    /// use abi_stable::std_types::RStr;
    ///
    /// const BAZ: NulStr<'_> = NulStr::from_str("baz qux\0");
    /// let baz: RStr<'_> = BAZ.to_rstr_with_nul();
    /// assert_eq!(&baz[..3], "baz");
    /// assert_eq!(&baz[4..], "qux\0");
    ///
    /// ```
    pub fn to_rstr_with_nul(&self) -> RStr<'a> {
        self.to_str_with_nul().into()
    }

    /// Converts this `NulStr<'a>` to a `&'a str`,not including the nul byte.
    ///
    /// # Performance
    ///
    /// This conversion requires traversing through the entire string to
    /// find the nul byte.
    ///
    /// # Example
    ///
    /// ```rust
    /// use abi_stable::sabi_types::NulStr;
    ///
    /// const FOO: NulStr<'_> = NulStr::from_str("foo bar\0");
    /// let foo: &str = FOO.to_str();
    /// assert_eq!(&foo[..3], "foo");
    /// assert_eq!(&foo[4..], "bar");
    ///
    /// ```
    pub fn to_str(self) -> &'a str {
        unsafe {
            let bytes = std::ffi::CStr::from_ptr(self.ptr.as_ptr() as *const _).to_bytes();
            std::str::from_utf8_unchecked(bytes)
        }
    }

    /// Converts this `NulStr<'a>` to a `&'a str`,not including the nul byte.
    ///
    /// # Performance
    ///
    /// To make this function const-callable,
    /// this uses a potentially less efficient approach than [`to_str`](Self::to_str).
    ///
    /// This conversion requires traversing through the entire string to
    /// find the nul byte.
    ///
    /// # Example
    ///
    /// ```rust
    /// use abi_stable::sabi_types::NulStr;
    ///
    /// const FOO: NulStr<'_> = NulStr::from_str("foo bar\0");
    /// const FOO_S: &str = FOO.const_to_str();
    /// assert_eq!(&FOO_S[..3], "foo");
    /// assert_eq!(&FOO_S[4..], "bar");
    ///
    /// ```
    #[cfg(feature = "rust_1_64")]
    #[cfg_attr(feature = "docsrs", doc(cfg(feature = "rust_1_64")))]
    pub const fn const_to_str(self) -> &'a str {
        unsafe {
            let len = self.compute_length();
            std::str::from_utf8_unchecked(std::slice::from_raw_parts(self.as_ptr(), len))
        }
    }

    /// Converts this `NulStr<'a>` to a `RStr<'a>`,not including the nul byte.
    ///
    /// # Performance
    ///
    /// This conversion requires traversing through the entire string to
    /// find the nul byte.
    ///
    /// # Example
    ///
    /// ```rust
    /// use abi_stable::sabi_types::NulStr;
    /// use abi_stable::std_types::RStr;
    ///
    /// const BAZ: NulStr<'_> = NulStr::from_str("baz qux\0");
    /// let baz: RStr<'_> = BAZ.to_rstr();
    /// assert_eq!(&baz[..3], "baz");
    /// assert_eq!(&baz[4..], "qux");
    ///
    /// ```
    pub fn to_rstr(self) -> RStr<'a> {
        self.to_str().into()
    }
}

impl<'a> PartialEq<NulStr<'a>> for &str {
    fn eq(&self, other: &NulStr<'a>) -> bool {
        self.as_ptr() == other.as_ptr() || *self == other.to_str()
    }
}

impl<'a> PartialEq<&str> for NulStr<'a> {
    fn eq(&self, other: &&str) -> bool {
        self.as_ptr() == other.as_ptr() || self.to_str() == *other
    }
}

impl<'a> PartialEq<NulStr<'a>> for str {
    fn eq(&self, other: &NulStr<'a>) -> bool {
        self.as_ptr() == other.as_ptr() || self == other.to_str()
    }
}

impl<'a> PartialEq<str> for NulStr<'a> {
    fn eq(&self, other: &str) -> bool {
        self.as_ptr() == other.as_ptr() || self.to_str() == other
    }
}

impl<'a> PartialEq for NulStr<'a> {
    fn eq(&self, other: &Self) -> bool {
        self.ptr == other.ptr || self.to_str() == other.to_str()
    }
}

impl<'a> Eq for NulStr<'a> {}

impl<'a> PartialOrd for NulStr<'a> {
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        Some(self.cmp(other))
    }
}

impl<'a> Ord for NulStr<'a> {
    fn cmp(&self, other: &Self) -> Ordering {
        if self.ptr == other.ptr {
            Ordering::Equal
        } else {
            self.to_str().cmp(other.to_str())
        }
    }
}

impl Default for NulStr<'_> {
    fn default() -> Self {
        NulStr::EMPTY
    }
}

impl Display for NulStr<'_> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        Display::fmt(self.to_str(), f)
    }
}

impl Debug for NulStr<'_> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        Debug::fmt(self.to_str(), f)
    }
}

/// Error from trying to convert a `&str` to a [`NulStr`]
///
/// [`NulStr`]: ./struct.NulStr.html
#[derive(Debug, PartialEq, Eq, Clone)]
#[non_exhaustive]
pub enum NulStrError {
    /// When the string has a `'\0'` before the end.
    InnerNul {
        /// the position of the first '\0' character.
        pos: usize,
    },
    /// When the string doesn't end with `'\0'`
    NoNulTerminator,
}

impl Display for NulStrError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match *self {
            Self::InnerNul { pos } => {
                write!(f, "there is an internal nul at the {} byte offset", pos)
            }
            Self::NoNulTerminator => f.write_str("there is no nul terminator in the string"),
        }
    }
}

impl std::error::Error for NulStrError {}