devela 0.28.0

A development substrate of coherence.
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

// devela::text::unicode::scalar::namespace::u16

use crate::Char;

/// # Methods over `u16`.
#[rustfmt::skip]
impl Char<u16> {
    /// Returns `true` if the given Unicode scalar code is a [surrogate code point][0].
    ///
    /// [0]: https://www.unicode.org/glossary/#surrogate_code_point
    #[must_use]
    pub const fn is_surrogate(self) -> bool { matches!(self.0, 0xD800..=0xDFFF) }

    /// Returns `true` if the given Unicode scalar code is a [leading surrogate][0].
    ///
    /// [0]: https://www.unicode.org/glossary/#high_surrogate_code_point
    #[must_use]
    pub const fn is_surrogate_high(self) -> bool { matches!(self.0, 0xD800..=0xDBFF) }

    /// Returns `true` if the given Unicode scalar code is a [trailing surrogate][0].
    ///
    /// [0]: https://www.unicode.org/glossary/#low_surrogate_code_point
    #[must_use]
    pub const fn is_surrogate_low(self) -> bool { matches!(self.0, 0xDC00..=0xDFFF) }

    /// Decodes the given surrogate pair.
    ///
    /// # Features
    /// Uses the `unsafe_str` feature to skip duplicated validation checks.
    #[must_use]
    pub const fn decode_surrogate_pair(high: u16, low: u16) -> Option<char> {
        if Char(high).is_surrogate_high() && Char(low).is_surrogate_low() {
            let code = 0x10000 + (((high as u32 - 0xD800) << 10) | (low as u32 - 0xDC00));
            cfg_select! { all(feature = "unsafe_str", not(feature = "safe_text")) => {
                Some(unsafe { char::from_u32_unchecked(code) }) // SAFETY: we just checked validity
            } _ => { char::from_u32(code) }}
        } else {
            None
        }
    }
}