Struct Utf16U16Codec 

pub struct Utf16U16Codec;

Combined UTF-16 u16 code-unit codec.

Utf16U16Codec works with UTF-16 code units rather than serialized bytes. Use crate::Utf16ByteCodec when the input or output is a byte stream with an explicit byte order.

Examples

use qubit_text_codec::{
    CharsetCodec,
    DecodeStatus,
    Charset,
    Utf16,
    Utf16U16Codec,
};

let codec = Utf16U16Codec;
assert_eq!(Charset::UTF_16, codec.charset());
assert_eq!(Utf16::MAX_UNITS_PER_CHAR, codec.max_units_per_char());

let mut output = [0_u16; Utf16::MAX_UNITS_PER_CHAR];
let written = codec.encode_one('😀', &mut output, 0).expect("buffer fits");
assert_eq!(
    DecodeStatus::Complete {
        value: '😀',
        consumed: written,
    },
    codec.decode_one(&output[..written], 0).expect("valid UTF-16"),
);

Implementations

impl Utf16U16Codec

pub const fn charset(self) -> Charset

Returns the UTF-16 encoding descriptor.

Returns

Returns Charset::UTF_16.

pub const fn max_units_per_char(self) -> usize

Returns the maximum number of UTF-16 code units needed for one character.

Returns

Returns Utf16::MAX_UNITS_PER_CHAR.

Trait Implementations

impl CharsetCodec for Utf16U16Codec

fn charset(&self) -> Charset

Returns UTF-16 charset descriptor.

Returns

Returns Charset::UTF_16.

fn max_units_per_char(&self) -> usize

Returns the maximum number of UTF-16 code units for one character.

Returns

Returns Utf16::MAX_UNITS_PER_CHAR.

fn decode_one( &self, input: &[u16], index: usize, ) -> CharsetDecodeResult<DecodeStatus>

Decodes one UTF-16 scalar value from a u16 prefix.

Arguments

• input - UTF-16 code-unit slice.
• index - Start offset for parsing; must satisfy index <= input.len().

Returns

• Ok(DecodeStatus::NeedMore { required, available }) when only a partial unit/pair is present.
• Ok(DecodeStatus::Complete { value, consumed }) when one character is decoded.

Errors

• crate::CharsetDecodeErrorKind::MalformedSequence for invalid surrogate combinations.
• crate::CharsetDecodeErrorKind::InvalidCodePoint when resulting scalar is invalid.

fn encode_one( &self, ch: char, output: &mut [u16], index: usize, ) -> CharsetEncodeResult<usize>

Encodes one Unicode scalar value into UTF-16 code units at index.

Arguments

• ch - The Unicode scalar value to encode.
• output - Destination u16 buffer.
• index - Start offset where units are written; must satisfy index <= output.len().

Returns

Ok(usize) with the number of written UTF-16 units (1 or 2).

Errors

• crate::CharsetEncodeErrorKind::BufferTooSmall if destination is insufficient.

type Unit = u16

Storage unit used by the encoded representation.

impl Clone for Utf16U16Codec

fn clone(&self) -> Utf16U16Codec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Utf16U16Codec

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

Formats the value using the given formatter.

impl Default for Utf16U16Codec

fn default() -> Utf16U16Codec

Returns the “default value” for a type.

impl Hash for Utf16U16Codec

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 PartialEq for Utf16U16Codec

fn eq(&self, other: &Utf16U16Codec) -> 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 Copy for Utf16U16Codec

impl Eq for Utf16U16Codec

impl StructuralPartialEq for Utf16U16Codec