oxc_str 0.154.0

A collection of JavaScript tools written in Rust.
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

use crate::wtf8::*;

/// A JavaScript string code point, including lone surrogates.
///
/// The value is always in `0..=0x10_FFFF`. Unlike [`char`], this includes the
/// surrogate range `0xD800..=0xDFFF`. A supplementary character is one `JSChar`,
/// even though it occupies two UTF-16 code units.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
#[repr(transparent)]
pub struct JSChar(u32);

impl JSChar {
    /// Construct a code point, returning `None` if `value > 0x10_FFFF`.
    #[inline]
    pub const fn from_u32(value: u32) -> Option<Self> {
        if value <= CODE_POINT_MAX { Some(Self(value)) } else { None }
    }

    /// Return the code point's numeric value.
    #[inline]
    pub const fn to_u32(self) -> u32 {
        self.0
    }

    /// Return a Unicode scalar value, or `None` for a lone surrogate.
    #[inline]
    pub const fn to_char(self) -> Option<char> {
        if self.is_surrogate() {
            None
        } else {
            // SAFETY: `JSChar` is at most 0x10_FFFF, and we excluded surrogates
            Some(unsafe { char::from_u32_unchecked(self.0) })
        }
    }

    /// Construct a code point without checking its range.
    ///
    /// # SAFETY
    /// `value` must be at most `0x10_FFFF`.
    #[inline]
    pub(super) const unsafe fn from_u32_unchecked(value: u32) -> Self {
        Self(value)
    }

    #[inline]
    pub(super) const fn from_code_unit(unit: u16) -> Self {
        Self(unit as u32)
    }

    #[inline]
    pub(super) const fn is_surrogate(self) -> bool {
        self.0 >= LEAD_SURROGATE_MIN && self.0 <= TRAIL_SURROGATE_MAX
    }

    #[inline]
    pub(super) const fn is_lead_surrogate(self) -> bool {
        self.0 >= LEAD_SURROGATE_MIN && self.0 <= LEAD_SURROGATE_MAX
    }

    #[inline]
    pub(super) const fn is_trail_surrogate(self) -> bool {
        self.0 >= TRAIL_SURROGATE_MIN && self.0 <= TRAIL_SURROGATE_MAX
    }

    /// Encode one code point. The caller handles pairing adjacent surrogates.
    #[inline]
    #[expect(clippy::cast_possible_truncation, reason = "each byte is masked or range-checked")]
    pub(super) fn encode(self, buffer: &mut [u8; char::MAX_LEN_UTF8]) -> &[u8] {
        let value = self.0;
        let len = match value {
            0..=ONE_BYTE_CODE_POINT_MAX => {
                buffer[0] = value as u8;
                1
            }
            TWO_BYTE_CODE_POINT_MIN..=TWO_BYTE_CODE_POINT_MAX => {
                buffer[0] = TWO_BYTE_TAG | (value >> 6) as u8;
                buffer[1] = CONT_TAG | (value as u8 & CONT_MASK);
                2
            }
            THREE_BYTE_CODE_POINT_MIN..=THREE_BYTE_CODE_POINT_MAX => {
                buffer[0] = THREE_BYTE_TAG | (value >> 12) as u8;
                buffer[1] = CONT_TAG | ((value >> 6) as u8 & CONT_MASK);
                buffer[2] = CONT_TAG | (value as u8 & CONT_MASK);
                3
            }
            _ => {
                buffer[0] = FOUR_BYTE_TAG | (value >> 18) as u8;
                buffer[1] = CONT_TAG | ((value >> 12) as u8 & CONT_MASK);
                buffer[2] = CONT_TAG | ((value >> 6) as u8 & CONT_MASK);
                buffer[3] = CONT_TAG | (value as u8 & CONT_MASK);
                4
            }
        };
        &buffer[..len]
    }
}