Enum unicode_bom::Bom

pub enum Bom {
    Null,
    Bocu1,
    Gb18030,
    Scsu,
    UtfEbcdic,
    Utf1,
    Utf7,
    Utf8,
    Utf16Be,
    Utf16Le,
    Utf32Be,
    Utf32Le,
}

Unicode byte-order mark (BOM) abstraction.

Variants

Null

Indicates no BOM was detected.

Bocu1

Indicates BOCU-1 BOM was detected.

Gb18030

Indicates GB 18030 BOM was detected.

Scsu

Indicates SCSU BOM was detected.

UtfEbcdic

Indicates UTF-EBCIDC BOM was detected.

Utf1

Indicates UTF-1 BOM was detected.

Utf7

Indicates UTF-7 BOM was detected.

Utf8

Indicates UTF-8 BOM was detected.

Utf16Be

Indicates UTF-16 (big-endian) BOM was detected.

Utf16Le

Indicates UTF-16 (little-endian) BOM was detected.

Utf32Be

Indicates UTF-32 (big-endian) BOM was detected.

Utf32Le

Indicates UTF-32 (little-endian) BOM was detected.

Implementations

impl Bom

pub fn len(&self) -> usize

Returns the size in bytes of the BOM.

Trait Implementations

impl AsRef<[u8]> for Bom

fn as_ref(&self) -> &[u8]

Returns the BOM byte-array literal.

Note that for UTF-7, only the first three bytes of the BOM are returned. That’s because the last two bits of the fourth byte belong to the following character, so it’s impossible to return the fourth byte without further context. Possible values for the missing fourth byte are 0x38, 0x39, 0x2a and 0x2b.

impl AsRef<str> for Bom

fn as_ref(&self) -> &str

Returns a &str representation of the BOM type.

impl Clone for Bom

fn clone(&self) -> Bom

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Bom

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

Formats the value using the given formatter.

impl Default for Bom

fn default() -> Self

Returns the default/empty BOM type, Bom::Null.

impl Display for Bom

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

Formats the BOM type as a String.

impl From<&[u8]> for Bom

fn from(slice: &[u8]) -> Self

Detect the BOM type from a byte array.

impl From<&mut File> for Bom

fn from(file: &mut File) -> Self

Detect the BOM type from a File instance.

Note that I/O errors are swallowed by this method. Instead the default type, Bom::Null, will be returned.

impl FromStr for Bom

type Err = Error

A std::io::Error instance returned by std::fs::File::open.

fn from_str(path: &str) -> Result<Self, Self::Err>

Parse the BOM type from the file located at path.

impl PartialEq for Bom

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for Bom

impl Eq for Bom

impl StructuralPartialEq for Bom