bump_scope/
from_utf16_error.rs

1use core::{error::Error, fmt};
2
3/// A possible error value when converting a string from a UTF-16 byte slice.
4///
5/// This type is the error type for the `from_utf16_in` method on
6/// <code>([Mut])[BumpString]</code>.
7///
8/// # Examples
9///
10/// ```
11/// # use bump_scope::{Bump, BumpString};
12/// # let bump: Bump = Bump::new();
13///
14/// // 𝄞mu<invalid>ic
15/// let v = &[0xD834, 0xDD1E, 0x006d, 0x0075,
16///           0xD800, 0x0069, 0x0063];
17///
18/// assert!(BumpString::from_utf16_in(v, &bump).is_err());
19/// ```
20///
21/// [Mut]: crate::MutBumpString::from_utf16_in
22/// [BumpString]: crate::BumpString::from_utf16_in
23#[derive(Debug)]
24pub struct FromUtf16Error(pub(crate) ());
25
26impl fmt::Display for FromUtf16Error {
27    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
28        fmt::Display::fmt("invalid utf-16: lone surrogate found", f)
29    }
30}
31
32impl Error for FromUtf16Error {}