Enum Format 

#[non_exhaustive]
pub enum Format {
    Html,
    Pdf,
    Docx,
    Doc,
    Xlsx,
    Xls,
    Ods,
    Pptx,
    Csv,
    PlainText,
    Markdown,
    Unknown,
}

Detected document format.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Html

Pdf

Docx

Office Open XML word processing (.docx, .docm, .dotx).

Doc

Legacy Word 97-2003 binary (.doc). Detected but not supported.

Xlsx

Office Open XML spreadsheet (.xlsx, .xlsm, .xltx).

Xls

Legacy Excel 97-2003 binary (.xls).

Ods

OpenDocument spreadsheet (.ods).

Pptx

Office Open XML presentation (.pptx). Detected but not supported.

Csv

PlainText

Markdown

Unknown

Implementations

impl Format

pub fn as_str(&self) -> &'static str

Short lowercase name ("docx", "xlsx", …).

pub fn from_content_type(content_type: &str) -> Self

Detect format from a MIME content type string.

pub fn from_extension(ext: &str) -> Self

Detect format from a file extension (without the dot).

pub fn from_file_name(name: &str) -> Self

Detect format from a file name or URL path (query/fragment ignored).

pub fn sniff(bytes: &[u8]) -> Self

Detect format from magic bytes / container contents.

pub fn detect(bytes: &[u8], hint: DocumentHint<'_>) -> Self

Detect format: content type, then file extension, then magic bytes.

Trait Implementations

impl Clone for Format

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Format

impl Debug for Format

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Format

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Format

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

Formats the value using the given formatter.

impl Eq for Format

impl Hash for Format

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 Format

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Format

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Format