Enum UnicodeBom 

pub enum UnicodeBom {
    Utf8,
    Utf16BigEndian,
    Utf16LittleEndian,
    Utf32BigEndian,
    Utf32LittleEndian,
}

Unicode byte order marks supported by this crate.

detect recognizes BOMs only from the bytes supplied to the call. Streaming callers should buffer up to four bytes, or read until EOF, before deciding that no longer BOM can be present.

Examples

use qubit_text_codec::{
    ByteOrder,
    Charset,
    UnicodeBom,
};

let bom = UnicodeBom::detect(&[0xff, 0xfe, 0x00, 0x00]);
assert_eq!(Some(UnicodeBom::Utf32LittleEndian), bom);

let bom = bom.expect("UTF-32LE BOM");
assert_eq!(Charset::UTF_32LE, bom.charset());
assert_eq!(Some(ByteOrder::LittleEndian), bom.byte_order());
assert_eq!(4, bom.byte_len());

Variants

Utf8

UTF-8 byte order mark.

Utf16BigEndian

UTF-16 big-endian byte order mark.

Utf16LittleEndian

UTF-16 little-endian byte order mark.

Utf32BigEndian

UTF-32 big-endian byte order mark.

Utf32LittleEndian

UTF-32 little-endian byte order mark.

Implementations

impl UnicodeBom

pub fn detect(bytes: &[u8]) -> Option<Self>

Detects a Unicode byte order mark at the beginning of bytes.

Parameters

• bytes: The byte buffer to inspect.

Returns

Returns the detected BOM, or None if no supported BOM prefix is present.

UTF-32 BOMs are checked before UTF-16 BOMs so that overlapping prefixes such as FF FE 00 00 are classified as UTF-32 little-endian when all four bytes are available.

pub const fn bytes(self) -> &'static [u8]

Returns the bytes that represent this BOM.

Returns

Returns a static byte slice containing the BOM bytes.

pub const fn byte_len(self) -> usize

Returns the byte length of this BOM.

Returns

Returns the number of bytes in this BOM.

pub const fn charset(self) -> Charset

Returns the charset indicated by this BOM.

Returns

Returns the corresponding Charset, including fixed byte order for UTF-16 and UTF-32 BOMs.

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

Returns the byte order indicated by this BOM when applicable.

Returns

Returns Some(ByteOrder) for UTF-16 and UTF-32 BOMs. Returns None for UTF-8 because byte order does not apply.

Trait Implementations

impl Clone for UnicodeBom

fn clone(&self) -> UnicodeBom

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UnicodeBom

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

Formats the value using the given formatter.

impl Hash for UnicodeBom

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 UnicodeBom

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

impl Eq for UnicodeBom

impl StructuralPartialEq for UnicodeBom