Struct CharsetConverter 

pub struct CharsetConverter<D, E>
where
    D: CharsetCodec,
    E: CharsetCodec,
{ /* private fields */ }

Converts units encoded with one charset into units encoded with another charset.

The converter owns a CharsetDecoder for the source charset and a CharsetEncoder for the target charset. A decoded character may be kept pending between calls when the target output buffer is full.

Type Parameters

• D: Low-level charset codec used by the source decoder.
• E: Low-level charset codec used by the target encoder.

use qubit_text_codec::{Coder, CharsetDecoder, CharsetEncoder, CharsetConverter, Utf8Codec, Utf16U16Codec};

let mut converter = CharsetConverter::new(
    CharsetDecoder::new(Utf8Codec),
    CharsetEncoder::new(Utf16U16Codec),
);
let mut output = [0_u16; 2];

let progress = converter
    .convert("AB".as_bytes(), 0, &mut output, 0)
    .expect("convert bytes to utf-16");

assert_eq!(2, progress.read());
assert_eq!(2, progress.written());
assert_eq!([65, 66], output);

Implementations

impl<D, E> CharsetConverter<D, E>

where D: CharsetCodec, E: CharsetCodec,

pub fn from_codecs(source: D, target: E) -> Self

Creates a charset converter from raw source and target codecs.

Parameters

• source: Source charset codec.
• target: Target charset codec.

Returns

Returns a converter with default decoder and encoder policies.

pub fn new(decoder: CharsetDecoder<D>, encoder: CharsetEncoder<E>) -> Self

Creates a charset converter from a decoder and an encoder.

Parameters

• decoder: Decoder configured for the source charset.
• encoder: Encoder configured for the target charset.

Returns

Returns a converter that composes the supplied decoder and encoder.

pub const fn decoder(&self) -> &CharsetDecoder<D>

Returns the source decoder.

Returns

Returns a shared reference to the configured decoder.

pub const fn encoder(&self) -> &CharsetEncoder<E>

Returns the target encoder.

Returns

Returns a shared reference to the configured encoder.

pub fn decoder_mut(&mut self) -> &mut CharsetDecoder<D>

Returns a mutable source decoder.

Returns

Returns a mutable reference to the configured decoder.

pub fn encoder_mut(&mut self) -> &mut CharsetEncoder<E>

Returns a mutable target encoder.

Returns

Returns a mutable reference to the configured encoder.

Trait Implementations

impl<D, E> Clone for CharsetConverter<D, E>

where D: CharsetCodec + Clone, E: CharsetCodec + Clone,

fn clone(&self) -> CharsetConverter<D, E>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<D, E> Coder<<D as CharsetCodec>::Unit, <E as CharsetCodec>::Unit> for CharsetConverter<D, E>

where D: CharsetCodec, E: CharsetCodec,

fn max_output_len(&self, input_len: usize) -> Option<usize>

Returns the target-side upper bound for converted output units.

fn reset(&mut self)

Clears any pending decoded character.

fn convert( &mut self, input: &[D::Unit], input_index: usize, output: &mut [E::Unit], output_index: usize, ) -> Result<CoderProgress, Self::Error>

Converts source units to target units through the configured decoder and encoder.

fn finish( &mut self, output: &mut [E::Unit], output_index: usize, ) -> Result<CoderProgress, Self::Error>

Flushes one pending decoded character, if any.

Parameters

• output: Complete output slice visible to the converter.
• output_index: Absolute output index where writing starts.

Returns

Returns completed progress when no pending character exists. Returns NeedOutput when pending output cannot be flushed due to missing output capacity.

Errors

Returns CharsetConvertError::Encode when encoding the pending character violates target charset policy.

type Error = CharsetConvertError

Error reported for semantic conversion failures.

impl<D, E> Debug for CharsetConverter<D, E>

where D: CharsetCodec + Debug, E: CharsetCodec + Debug,

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

Formats the value using the given formatter.

impl<D, E> PartialEq for CharsetConverter<D, E>

where D: CharsetCodec + PartialEq, E: CharsetCodec + PartialEq,

fn eq(&self, other: &CharsetConverter<D, E>) -> 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<D, E> Eq for CharsetConverter<D, E>

where D: CharsetCodec + Eq, E: CharsetCodec + Eq,

impl<D, E> StructuralPartialEq for CharsetConverter<D, E>

where D: CharsetCodec, E: CharsetCodec,