Struct Utf32U32Codec 

pub struct Utf32U32Codec;

Combined UTF-32 u32 code-unit codec.

Utf32U32Codec works with raw UTF-32 scalar-value units rather than serialized bytes. Use crate::Utf32ByteCodec for byte streams with an explicit byte order.

Examples

use qubit_text_codec::{
    CharsetCodec,
    DecodeStatus,
    Charset,
    Utf32,
    Utf32U32Codec,
};

let codec = Utf32U32Codec;
assert_eq!(Charset::UTF_32, codec.charset());
assert_eq!(Utf32::MAX_UNITS_PER_CHAR, codec.max_units_per_char());

let mut output = [0_u32; Utf32::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-32"),
);

Implementations

impl Utf32U32Codec

pub const fn charset(self) -> Charset

Returns the UTF-32 encoding descriptor.

Returns

Returns Charset::UTF_32.

pub const fn max_units_per_char(self) -> usize

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

Returns

Returns Utf32::MAX_UNITS_PER_CHAR.

Trait Implementations

impl CharsetCodec for Utf32U32Codec

fn charset(&self) -> Charset

Returns UTF-32 charset descriptor.

Returns

Returns Charset::UTF_32.

fn max_units_per_char(&self) -> usize

Returns the fixed size (1 unit) for one UTF-32 scalar value.

Returns

Returns Utf32::MAX_UNITS_PER_CHAR.

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

Decodes one UTF-32 scalar value from a u32 prefix.

Arguments

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

Returns

• Ok(DecodeStatus::NeedMore { required, available }) when no unit is available.
• Ok(DecodeStatus::Complete { value, consumed }) with consumed == 1.

Errors

• crate::CharsetDecodeErrorKind::MalformedSequence when index is out of bounds.
• crate::CharsetDecodeErrorKind::InvalidCodePoint when unit is not a valid scalar.

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

Encodes one Unicode scalar value into a u32 unit at index.

Arguments

• ch - The Unicode scalar value to encode.
• output - Destination u32 buffer.
• index - Start offset where one unit is written; must satisfy index < output.len().

Returns

Always returns Ok(1) on success.

Errors

• crate::CharsetEncodeErrorKind::BufferTooSmall if output has no room at index.

type Unit = u32

Storage unit used by the encoded representation.

impl Clone for Utf32U32Codec

fn clone(&self) -> Utf32U32Codec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Utf32U32Codec

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

Formats the value using the given formatter.

impl Default for Utf32U32Codec

fn default() -> Utf32U32Codec

Returns the “default value” for a type.

impl Hash for Utf32U32Codec

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 Utf32U32Codec

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

impl Eq for Utf32U32Codec

impl StructuralPartialEq for Utf32U32Codec