Struct char16

pub struct char16(/* private fields */);

Available on crate feature _char16 only.

A 16-bit unicode scalar, limited to the Basic Multilingual Plane subset.

It can represent every scalar from the Basic Multilingual Plane (BMP), the first and most important plane in the Unicode standard (also known as plane 0), containing nearly all commonly used writing systems and symbols.

Option<char16> is the same size as char16 (2 bytes).

See also: char7, char8, char.

Implementations

impl char16

pub const MIN: char16

The lowest unicode scalar a char16 can represent, '\u{00}'.

pub const MAX: char16

The highest unicode scalar a char16 can represent, '\u{FFFF}'.

Note that '\u{FFFF}' is a noncharacter.

pub const REPLACEMENT_CHARACTER: char16

U+FFFD REPLACEMENT CHARACTER (�) is used in Unicode to represent a decoding error.

pub const fn from_ascii_char(c: AsciiChar) -> char16

Available on crate feature ascii only.

Converts an AsciiChar to char16.

pub const fn from_char7(c: char7) -> char16

Available on crate feature _char7 only.

Converts a char7 to char16.

pub const fn from_char8(c: char8) -> char16

Available on crate feature _char8 only.

Converts a char8 to char16.

pub const fn try_from_char(c: char) -> Result<char16, DataOverflow>

Tries to convert a char to char16.

Errors

Returns DataOverflow if the character can’t fit in 16 bits.

pub const fn try_to_ascii_char(self) -> Result<AsciiChar, DataOverflow>

Available on crate feature ascii only.

Tries to convert this char16 to AsciiChar.

Errors

Returns DataOverflow if self can’t fit in 7 bits.

Features

Makes use of the unsafe_niche feature if enabled.

pub const fn try_to_char7(self) -> Result<char7, DataOverflow>

Available on crate feature _char7 only.

Tries to convert this char16 to char7.

Errors

Returns DataOverflow if self can’t fit in 7 bits.

pub const fn try_to_char8(self) -> Result<char8, DataOverflow>

Available on crate feature _char8 only.

Tries to convert this char16 to char8.

Errors

Returns DataOverflow if self can’t fit in 8 bits.

pub const fn to_char(self) -> char

Converts this char16 to char.

pub const fn to_u32(self) -> u32

Converts this char16 to u32.

pub const fn to_utf8_bytes(self) -> [u8; 3]

Converts this char16 to an UTF-8 encoded sequence of bytes.

Note that this function always returns a 3-byte array, but the actual UTF-8 sequence may be shorter. The unused bytes are set to 0.

pub const fn to_ascii_uppercase(self) -> char16

Makes a copy of the value in its ASCII upper case equivalent.

ASCII letters ‘a’ to ‘z’ are mapped to ‘A’ to ‘Z’, but non-ASCII letters are unchanged.

pub const fn to_ascii_lowercase(self) -> char16

Makes a copy of the value in its ASCII lower case equivalent.

ASCII letters ‘A’ to ‘Z’ are mapped to ‘a’ to ‘z’, but non-ASCII letters are unchanged.

pub const fn is_noncharacter(self) -> bool

Returns true if this unicode scalar is a noncharacter.

pub const fn is_character(self) -> bool

Returns true if this unicode scalar is an abstract character.

pub const fn is_ascii(self) -> bool

Checks if the value is within the ASCII range.

impl char16

pub const fn byte_len(self) -> usize

Returns the number of bytes needed to represent the scalar value.

pub const fn len_utf8(self) -> usize

Returns the number of bytes needed to encode in UTF-8.

pub const fn len_utf16(self) -> usize

Returns the number of bytes needed to encode in UTF-16.

pub const fn to_digit(self, radix: u32) -> Option<u32>

Converts the scalar to a digit in the given radix.

‘Digit’ is defined to be only the following characters: 0-9, a-z, A-Z.

Errors

Returns None if the char does not refer to a digit in the given radix.

Panics

Panics if given a radix larger than 36.

pub const fn is_nul(self) -> bool

Returns true if this is the nul character (0x00).

pub const fn is_digit(self, radix: u32) -> bool

Checks if the unicode scalar is a digit in the given radix.

See also to_digit.

Trait Implementations

impl Binary for char16

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl BitSized<16> for char16

const BIT_SIZE: usize = _

The bit size of this type (only the relevant data part, without padding).

const MIN_BYTE_SIZE: usize = _

The rounded up byte size for this type.

fn bit_size(&self) -> usize

Returns the bit size of this type (only the relevant data part, without padding).

fn min_byte_size(&self) -> usize

Returns the rounded up byte size for this type.

impl Clone for char16

fn clone(&self) -> char16

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ConstDefault for char16

const DEFAULT: Self

Returns the default value of \x00 (nul character).

impl Debug for char16

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for char16

fn default() -> Self

Returns the default value of \x00 (nul character).

impl Display for char16

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<char16> for char

fn from(c: char16) -> char

Converts to this type from the input type.

impl From<char7> for char16

fn from(c: char7) -> char16

Converts to this type from the input type.

impl From<char8> for char16

fn from(c: char8) -> char16

Converts to this type from the input type.

impl Hash for char16

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for char16

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Octal for char16

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Ord for char16

fn cmp(&self, other: &char16) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for char16

fn eq(&self, other: &char16) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for char16

fn partial_cmp(&self, other: &char16) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<char> for char16

type Error = DataOverflow

The type returned in the event of a conversion error.

fn try_from(c: char) -> Result<char16, DataOverflow>

Performs the conversion.

impl TryFrom<char16> for char7

type Error = DataOverflow

The type returned in the event of a conversion error.

fn try_from(c: char16) -> Result<char7, DataOverflow>

Performs the conversion.

impl TryFrom<char16> for char8

type Error = DataOverflow

The type returned in the event of a conversion error.

fn try_from(c: char16) -> Result<char8, DataOverflow>

Performs the conversion.

impl UnicodeScalar for char16

const MIN: Self = Self::MIN

The lowest unicode scalar that can be represented.

const MAX: Self = Self::MAX

The highest unicode scalar that can be represented.

fn byte_len(self) -> usize

Returns the number of bytes needed to represent the scalar value.

fn len_utf8(self) -> usize

Returns the number of bytes needed to encode in UTF-8.

fn len_utf16(self) -> usize

Returns the number of bytes needed to encode in UTF-16.

fn encode_utf8(self, dst: &mut [u8]) -> &mut str

Encodes this scalar as UTF-8 into the provided byte buffer, and then returns the subslice of the buffer that contains the encoded scalar.

fn to_utf8_bytes(self) -> [u8; 4]

Converts this scalar to an UTF-8 encoded sequence of bytes.

fn encode_utf16(self, dst: &mut [u16]) -> &mut [u16]

Encodes this scalar as UTF-16 into the provided byte buffer, and then returns the subslice of the buffer that contains the encoded scalar.

fn to_digit(self, radix: u32) -> Option<u32>

Converts the scalar to a digit in the given radix.

fn to_ascii_uppercase(self) -> Self

Makes a copy of the value in its ASCII upper case equivalent.

fn to_ascii_lowercase(self) -> Self

Makes a copy of the value in its ASCII lower case equivalent.

fn is_noncharacter(self) -> bool

Returns true if this unicode scalar is a noncharacter.

fn is_digit(self, radix: u32) -> bool

Checks if the unicode scalar is a digit in the given radix.

fn is_control(self) -> bool

Returns true if this unicode scalar has the general category for control codes.

fn is_nul(self) -> bool

Returns true if this unicode scalar is the nul character (0x00).

fn is_alphabetic(self) -> bool

Returns true if this unicode scalar has the Alphabetic property.

fn is_numeric(self) -> bool

Returns true if this unicode scalar has one of the general categories for numbers.

fn is_alphanumeric(self) -> bool

Returns true if this unicode scalar satisfies either is_alphabetic() or is_numeric().

fn is_lowercase(self) -> bool

Returns true if this unicode scalar has the Lowercase property.

fn is_uppercase(self) -> bool

Returns true if this unicode scalar has the Lowercase property.

fn is_whitespace(self) -> bool

Returns true if this unicode scalar has the White_Space property.

fn is_ascii(self) -> bool

Checks if the value is within the ASCII range.

fn is_character(self) -> bool

where Self: Sized,

Returns true if this unicode scalar is an abstract character.

impl UpperHex for char16

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Copy for char16

impl Eq for char16

impl StructuralPartialEq for char16