Struct Utf16ByteCodec 

pub struct Utf16ByteCodec { /* private fields */ }

Combined byte-serialized UTF-16 codec.

The codec uses one configured byte order for both decoding and encoding. It does not detect, consume, or emit a BOM automatically; callers should use crate::UnicodeBom when a byte stream may carry an explicit BOM.

Examples

use qubit_text_codec::{
    ByteOrder,
    CharsetCodec,
    DecodeStatus,
    Charset,
    Utf16,
    Utf16ByteCodec,
};

let codec = Utf16ByteCodec::new(ByteOrder::LittleEndian);
assert_eq!(Charset::UTF_16LE, codec.charset());
assert_eq!(Utf16::MAX_BYTES_PER_CHAR, codec.max_units_per_char());

let mut output = [0_u8; Utf16::MAX_BYTES_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-16LE"),
);

Implementations

impl Utf16ByteCodec

pub const fn new(byte_order: ByteOrder) -> Self

Creates a byte-serialized UTF-16 codec.

Parameters

• byte_order: The byte order used by the byte buffer.

Returns

Returns a UTF-16 byte codec.

pub const fn byte_order(self) -> ByteOrder

Returns the configured byte order.

Returns

Returns the byte order used by this codec.

pub const fn charset(self) -> Charset

Returns the fixed-endian UTF-16 charset descriptor.

Returns

Returns Charset::UTF_16LE or Charset::UTF_16BE according to this codec’s configured byte order.

pub const fn max_units_per_char(self) -> usize

Returns the maximum number of serialized UTF-16 bytes for one character.

Returns

Returns Utf16::MAX_BYTES_PER_CHAR.

Trait Implementations

impl CharsetCodec for Utf16ByteCodec

fn charset(&self) -> Charset

Returns the fixed-endian UTF-16 charset for the configured byte order.

Returns

Returns Charset::UTF_16BE when configured with ByteOrder::BigEndian, otherwise Charset::UTF_16LE.

fn max_units_per_char(&self) -> usize

Returns the maximum number of UTF-16 bytes for a single encoded character.

Returns

Returns Utf16::MAX_BYTES_PER_CHAR.

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

Decodes one UTF-16 scalar value from a byte-prefixed UTF-16 stream.

Arguments

• input - Byte-prefixed UTF-16 buffer.
• index - Start offset for parsing; must satisfy index <= input.len().

Returns

• Ok(DecodeStatus::NeedMore { required, available }) when the current slice has only a partial unit/pair.
• Ok(DecodeStatus::Complete { value, consumed }) when one Unicode scalar value is decoded.

Errors

• CharsetDecodeError when UTF-16 structure is malformed.

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

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

Arguments

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

Returns

Ok(usize) with the number of written bytes (2 for BMP and 4 for supplementary).

Errors

• crate::CharsetEncodeErrorKind::BufferTooSmall if output does not have enough space.

type Unit = u8

Storage unit used by the encoded representation.

impl Clone for Utf16ByteCodec

fn clone(&self) -> Utf16ByteCodec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Utf16ByteCodec

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

Formats the value using the given formatter.

impl Hash for Utf16ByteCodec

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

where H: Hasher,

Hashes the fixed-endian UTF-16 charset identity.

Parameters

• state: The hasher receiving this codec’s identity.

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 Utf16ByteCodec

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

impl Eq for Utf16ByteCodec

impl StructuralPartialEq for Utf16ByteCodec