Struct Charset 

pub struct Charset { /* private fields */ }

Identifies the charset associated with a codec or error.

A charset is represented by a stable normalized identifier, a display name, and accepted aliases. Equality and hashing use only the identifier, so display names and alias lists can evolve without changing identity.

Examples

use qubit_codec_text::Charset;

const GBK: Charset = Charset::new("gbk", "GBK", &["cp936"]);

assert!(GBK.matches_label("CP936"));
assert_eq!(GBK, Charset::new("gbk", "Chinese GBK", &[]));
assert_eq!("GBK", GBK.to_string());

Implementations

impl Charset

pub const ASCII: Self

US-ASCII text.

pub const ISO_8859_1: Self

ISO-8859-1 / Latin-1 text.

pub const UTF_8: Self

UTF-8 text.

pub const UTF_16: Self

UTF-16 text.

pub const UTF_16LE: Self

UTF-16 text serialized in little-endian byte order.

pub const UTF_16BE: Self

UTF-16 text serialized in big-endian byte order.

pub const UTF_32: Self

UTF-32 text.

pub const UTF_32LE: Self

UTF-32 text serialized in little-endian byte order.

pub const UTF_32BE: Self

UTF-32 text serialized in big-endian byte order.

pub const BUILTINS: &'static [Self]

Built-in charsets known by this crate.

pub const fn new( id: &'static str, name: &'static str, aliases: &'static [&'static str], ) -> Self

Creates a charset descriptor.

Parameters

• id: Stable normalized identifier used for equality and hashing.
• name: Human-readable display name.
• aliases: Additional labels accepted for this charset.

Returns

Returns a charset descriptor carrying the supplied metadata.

pub fn from_label(label: &str) -> Option<Self>

Finds a built-in charset by label.

Parameters

• label: Charset label to match against built-in identifiers, names, and aliases.

Returns

Returns Some(Charset) when label names one of this crate’s built-in charsets, or None when no built-in charset matches. Custom descriptors created with Self::new are not part of this lookup. Leading and trailing ASCII whitespace is ignored before matching.

pub const fn id(self) -> &'static str

Returns the stable normalized charset identifier.

Returns

Returns the identifier used for equality and hashing.

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

Returns a human-readable charset label.

Returns

Returns the display name stored in this descriptor.

pub const fn aliases(self) -> &'static [&'static str]

Returns accepted aliases for this charset.

Returns

Returns the static alias list stored in this descriptor.

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

Returns the UTF-16 charset with a fixed byte order.

Parameters

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

Returns

Returns Self::UTF_16LE for little-endian byte order and Self::UTF_16BE for big-endian byte order.

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

Returns the UTF-32 charset with a fixed byte order.

Parameters

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

Returns

Returns Self::UTF_32LE for little-endian byte order and Self::UTF_32BE for big-endian byte order.

pub fn byte_order(self) -> Option<ByteOrder>

Returns the fixed byte order represented by this charset.

Returns

Returns Some(ByteOrder) for fixed-endian UTF-16 and UTF-32 charsets. Returns None for UTF-8 and generic UTF-16/UTF-32 charsets.

pub fn matches_label(self, label: &str) -> bool

Tests whether a label names this charset.

Parameters

• label: The label to compare with this descriptor’s identifier, display name, and aliases.

Returns

Returns true when label matches the identifier, display name, or one of the aliases using ASCII case-insensitive comparison.

Trait Implementations

impl Clone for Charset

fn clone(&self) -> Charset

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Charset

impl Debug for Charset

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

Formats the value using the given formatter.

impl Display for Charset

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

Formats this charset label.

Parameters

• formatter: The formatter receiving the label.

Errors

Returns any formatting error reported by formatter.

impl Eq for Charset

impl Hash for Charset

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

where H: Hasher,

Hashes the stable encoding identifier.

Parameters

• state: The hasher receiving this encoding’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 Charset

fn eq(&self, other: &Self) -> bool

Compares charsets by stable identifier.

Parameters

• other: The descriptor to compare against.

Returns

Returns true when both descriptors have the same identifier.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.