Struct Utf8Codec 

pub struct Utf8Codec;

UTF-8 byte-buffer charset codec.

Examples

use qubit_codec_text::{
    CharsetCodec,
    CharsetEncodeProbe,
    Codec,
    Charset,
    Utf8,
    Utf8Codec,
};

let codec = Utf8Codec;
assert_eq!(Charset::UTF_8, codec.charset());
assert_eq!(Utf8::MAX_UNITS_PER_CHAR, codec.max_units_per_value().get());

let mut output = [0_u8; Utf8::MAX_BYTES_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-8")
};
assert_eq!(('é', written), (value, consumed.get()));

Implementations

impl Utf8Codec

pub const fn charset(self) -> Charset

Returns the UTF-8 encoding descriptor.

Returns

Returns Charset::UTF_8.

Trait Implementations

impl CharsetCodec for Utf8Codec

fn charset(&self) -> Charset

Returns UTF-8 charset descriptor.

Returns

Returns Charset::UTF_8.

impl CharsetEncodeProbe for Utf8Codec

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

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

Arguments

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

Returns

Ok(usize) with required encoded bytes (1..=4).

impl Clone for Utf8Codec

fn clone(&self) -> Utf8Codec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Codec for Utf8Codec

type Value = char

Logical value decoded from or encoded into the buffer.

type Unit = u8

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: &[u8], index: usize, ) -> CharsetDecodeResult<(char, NonZeroUsize)>

Decodes one value from input starting at index.

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

Encodes one borrowed value into output starting at index.

impl Copy for Utf8Codec

impl Debug for Utf8Codec

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

Formats the value using the given formatter.

impl Default for Utf8Codec

fn default() -> Utf8Codec

Returns the “default value” for a type.

impl Eq for Utf8Codec

impl Hash for Utf8Codec

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 Utf8Codec

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