Struct encoding::codec::utf_16::UTF16Encoding

pub struct UTF16Encoding<E> { /* fields omitted */ }

UTF-16 (UCS Transformation Format, 16-bit).

This is a Unicode encoding where one codepoint may use 2 (up to U+FFFF) or 4 bytes (up to U+10FFFF) depending on its value. It uses a "surrogate" mechanism to encode non-BMP codepoints, which are represented as a pair of lower surrogate and upper surrogate characters. In this effect, surrogate characters (U+D800..DFFF) cannot appear alone and cannot be included in a valid Unicode string.

Specialization

This type is specialized with endianness type E, which should be either Little (little endian) or Big (big endian).

Trait Implementations

impl<E: Endian> Encoding for UTF16Encoding<E>

fn name(&self) -> &'static str

Returns the canonical name of given encoding. This name is guaranteed to be unique across built-in encodings, but it is not normative and would be at most arbitrary.

fn whatwg_name(&self) -> Option<&'static str>

Returns a name of given encoding defined in the WHATWG Encoding standard, if any. This name often differs from name due to the compatibility reason.

fn raw_encoder(&self) -> Box<dyn RawEncoder>

Creates a new encoder.

fn raw_decoder(&self) -> Box<dyn RawDecoder>

Creates a new decoder.

fn encode(
    &self,
    input: &str,
    trap: EncoderTrap
) -> Result<Vec<u8>, Cow<'static, str>>

An easy-to-use interface to RawEncoder. On the encoder error trap is called, which may return a replacement sequence to continue processing, or a failure to return the error.

fn encode_to(
    &self,
    input: &str,
    trap: EncoderTrap,
    ret: &mut dyn ByteWriter
) -> Result<(), Cow<'static, str>>

Encode into a ByteWriter.

fn decode(
    &self,
    input: &[u8],
    trap: DecoderTrap
) -> Result<String, Cow<'static, str>>

An easy-to-use interface to RawDecoder. On the decoder error trap is called, which may return a replacement string to continue processing, or a failure to return the error.

fn decode_to(
    &self,
    input: &[u8],
    trap: DecoderTrap,
    ret: &mut dyn StringWriter
) -> Result<(), Cow<'static, str>>

Decode into a StringWriter.

impl<E: Clone> Clone for UTF16Encoding<E>

fn clone(&self) -> UTF16Encoding<E>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E: Copy> Copy for UTF16Encoding<E>