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_codec_text::{
    CharsetCodec,
    CharsetEncodeProbe,
    Codec,
    Charset,
    Utf16,
    Utf16U16Codec,
};

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

let mut output = [0_u16; Utf16::MAX_UNITS_PER_CHAR];
let written = codec.encode_len('😀', 0).expect("mappable");
unsafe {
    codec.encode_unchecked(&'😀', &mut output, 0).expect("buffer fits");
}
let (value, consumed) = unsafe {
    codec.decode_unchecked(&output[..written], 0).expect("valid UTF-16")
};
assert_eq!(('😀', written), (value, consumed.get()));

Implementations

impl Utf16U16Codec

pub const fn charset(self) -> Charset

Returns the UTF-16 encoding descriptor.

Returns

Returns Charset::UTF_16.

Trait Implementations

impl CharsetCodec for Utf16U16Codec

fn charset(&self) -> Charset

Returns UTF-16 charset descriptor.

Returns

Returns Charset::UTF_16.

impl CharsetEncodeProbe for Utf16U16Codec

fn encode_len(&self, ch: char, _index: usize) -> CharsetEncodeResult<usize>

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

Arguments

• ch - The Unicode scalar value to encode.
• index - Input character index used for error context.

Returns

Ok(usize) with the required UTF-16 units (1 or 2).

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

type Value = char

Logical value decoded from or encoded into the buffer.

type Unit = u16

Buffer unit used by the encoded representation.

type DecodeError = CharsetDecodeError

Error reported when decoding malformed units.

type EncodeError = CharsetEncodeError

Error reported when encoding an unsupported value.

fn min_units_per_value(&self) -> NonZeroUsize

Returns the minimum possible unit count for one encoded value.

fn max_units_per_value(&self) -> NonZeroUsize

Returns the maximum non-zero unit count needed to encode or decode one value.

unsafe fn decode_unchecked( &self, input: &[u16], index: usize, ) -> CharsetDecodeResult<(char, NonZeroUsize)>

Decodes one value from input starting at index.

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

Encodes one borrowed value into output starting at index.

impl Copy for Utf16U16Codec

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

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