Enum file_format::FileFormat[−][src]

pub enum FileFormat {
Show 118 variants    Odp,
    Ods,
    Odg,
    Odt,
    Vdi,
    Epub,
    Skp,
    Deb,
    InDesignDocument,
    Sqlite3,
    Html,
    ICalendar,
    Mxf,
    Apng,
    Jpeg,
    JpegXl,
    Ktx,
    Ktx2,
    Matroska,
    VCard,
    Fits,
    OggAudio,
    OggVideo,
    QuickTime,
    Wmv,
    GbcRom,
    Lzop,
    Orf,
    Aiff,
    Mobi,
    Avi,
    Avif,
    GbRom,
    GbaRom,
    Heif,
    Lnk,
    Mp4,
    Msi,
    N64Rom,
    NdsRom,
    Png,
    Rar,
    Tar,
    Wave,
    WebM,
    WebP,
    Xcf,
    Ar,
    Blender,
    Jp2,
    M4a,
    M4v,
    ThirdGpp,
    ThirdGpp2,
    Gif,
    SevenZip,
    Xml,
    Xz,
    Amr,
    Eot,
    Iso,
    OpenType,
    Pdf,
    Rtf,
    TrueType,
    Ape,
    AppleIconImage,
    Bpg,
    Cab,
    ChromeExtension,
    Cineon,
    Dex,
    Dicom,
    Dpx,
    Elf,
    Flac,
    Flif,
    Flv,
    Gltf,
    Ico,
    JavaClass,
    Lrzip,
    Lz4,
    Lzip,
    Midi,
    Mpc,
    Mpeg,
    NesRom,
    OpenExr,
    Pcap,
    Pcapng,
    PhotoshopDocument,
    Rpm,
    Shapefile,
    Snd,
    Tiff,
    WavPack,
    WebAssembly,
    Wmf,
    Woff,
    Woff2,
    Xar,
    Zip,
    Zstandard,
    Bzip2,
    JpegXr,
    Mp3,
    Swf,
    Aac,
    Ac3,
    AppleDiskImage,
    Bmp,
    Compress,
    Exe,
    Gzip,
    M2ts,
    Text,
    Binary,
}

Expand description

Represents a file format.

Variants

Odp

OpenDocument Presentation (ODP)

Ods

OpenDocument SpreadSheet (ODS)

Odg

OpenDocument Graphics (ODG)

Odt

OpenDocument Text (ODT)

Vdi

VirtualBox Virtual Disk Image (VDI)

Epub

Electronic Publication (EPUB)

Skp

SketchUp Document

Deb

Debian package

InDesignDocument

Adobe InDesign document

Sqlite3

SQLite 3 Database

Html

HyperText Markup Language (HTML)

ICalendar

iCalendar

Mxf

Material Exchange Format (MXF)

Apng

Animated Portable Network Graphics (APNG)

Jpeg

Joint Photographic Experts Group (JPEG)

JpegXl

JPEG XL

Ktx

Khronos TeXture (KTX)

Ktx2

Khronos TeXture 2 (KTX2)

Matroska

Matroska Multimedia Container

VCard

vCard

Fits

Flexible Image Transport System (FITS)

OggAudio

Ogg audio

OggVideo

Ogg video

QuickTime

QuickTime Movie

Wmv

Windows Media Video (WMV)

GbcRom

Game Boy Color ROM

Lzop

Lzop

Orf

Olympus Raw Format (ORF)

Aiff

Audio Interchange File Format (AIFF)

Mobi

Mobipocket

Avi

Audio Video Interleave (AVI)

Avif

AV1 Image File Format (AVIF)

GbRom

Game Boy ROM

GbaRom

Game Boy Advance ROM

Heif

High Efficiency Image File Format (HEIF)

Lnk

Windows shortcut

Mp4

MPEG-4 Part 14 (MP4)

Msi

Windows Installer

N64Rom

Nintendo 64 ROM

NdsRom

Nintendo DS ROM

Png

Portable Network Graphics (PNG)

Rar

Roshal ARchive (RAR)

Tar

Tape archive (tar)

Wave

Waveform Audio (WAVE)

WebM

WebM

WebP

WebP

Xcf

eXperimental Computing Facility (XCF)

Ar

Archiver

Blender

Blender 3D Data

Jp2

JPEG 2000

M4a

Audio-only MPEG-4

M4v

M4V

ThirdGpp

3rd Generation Partnership Project (3GPP)

ThirdGpp2

3rd Generation Partnership Project 2 (3GPP2)

Gif

Graphics Interchange Format (GIF)

SevenZip

7-Zip

Xml

Extensible Markup Language (XML)

Xz

XZ

Amr

Adaptive Multi-Rate (AMR)

Eot

Embedded OpenType (EOT)

Iso

ISO image

OpenType

OpenType

Pdf

Portable Document Format (PDF)

Rtf

Rich Text Format (RTF)

TrueType

TrueType

Ape

Monkey’s Audio

AppleIconImage

Apple Icon Image

Bpg

Better Portable Graphics (BPG)

Cab

Cabinet (CAB)

ChromeExtension

Google Chrome Extension

Cineon

Cineon Image

Dex

Dalvik Executable

Dicom

Digital Imaging and Communications in Medicine (DICOM)

Dpx

Digital Picture Exchange (DPX)

Elf

Executable and Linkable Format (ELF)

Flac

Free Lossless Audio Codec (FLAC)

Flif

Free Lossless Image Format (FLIF)

Flv

Flash Video (FLV)

Gltf

GL Transmission Format (glTF) binary

Ico

ICO

JavaClass

Java class

Lrzip

Long Range ZIP (lrzip)

Lz4

LZ4

Lzip

Lzip

Midi

Musical Instrument Digital Interface (MIDI)

Mpc

Musepack (MPC)

Mpeg

MPEG-1 video

NesRom

Nintendo Entertainment System ROM

OpenExr

OpenEXR

Pcap

Libpcap

Pcapng

Pcap-NG Packet Capture

PhotoshopDocument

Adobe Photoshop document

Rpm

Red Hat Package Manager (RPM) package

Shapefile

Shapefile

Snd

SouND (SND)

Tiff

Tag Image File Format (TIFF)

WavPack

WavPack

WebAssembly

WebAssembly binary

Wmf

Windows Metafile (WMF)

Woff

Web Open Font Format (WOFF)

Woff2

Web Open Font Format 2 (WOFF2)

Xar

eXtensible ARchive format (XAR)

Zip

ZIP

Zstandard

Zstandard

Bzip2

Bzip2

JpegXr

JPEG extended range (JPEG XR)

Mp3

MPEG-1/2 Audio Layer III (MP3)

Swf

Small Web Format (SWF)

Aac

Advanced Audio Coding (AAC)

Ac3

Audio Codec 3 (AC-3)

AppleDiskImage

Apple Disk Image

Bmp

Windows Bitmap (BMP)

Compress

Unix compress

Exe

Windows Executable

Gzip

Gzip

M2ts

MPEG-2 Transport Stream (M2TS)

Text

UTF-8 encoded text

Binary

Arbitrary binary data

Implementations

[src]

impl FileFormat

[src]

pub fn from_bytes(bytes: &[u8 ]) -> FileFormat

Determines file format from bytes.

If the signature of the file is not recognized, it will try to detect if the file is an UTF-8 encoded text and if so return FileFormat::Text. Otherwise, it will return FileFormat::Binary which corresponds to arbitrary binary data.

Examples

Detects from the first bytes of a PNG file:

use file_format::FileFormat;

let format = FileFormat::from_bytes(b"\x89\x50\x4E\x47\x0D\x0A\x1A\x0A");
assert_eq!(format, FileFormat::Png);
assert_eq!(format.media_type(), "image/png");
assert_eq!(format.preferred_extension(), "png");

Detects from an UTF-8 text:

use file_format::FileFormat;

let format = FileFormat::from_bytes("岁月不留人".as_bytes());
assert_eq!(format, FileFormat::Text);
assert_eq!(format.media_type(), "text/plain");
assert_eq!(format.preferred_extension(), "txt");

Detects from a zeroed buffer:

use file_format::FileFormat;

let format = FileFormat::from_bytes(&[0; 1000]);
assert_eq!(format, FileFormat::Binary);
assert_eq!(format.media_type(), "application/octet-stream");
assert_eq!(format.preferred_extension(), "bin");

[src]

pub fn from_extension(extension: &str) -> Option<FileFormat>

Determines file format from an extension.

Examples

Detects from an extension:

use file_format::FileFormat;

let format = FileFormat::from_extension("ttf");
assert_eq!(format, Some(FileFormat::TrueType));

Detects from an unknown extension:

use file_format::FileFormat;

let format = FileFormat::from_extension("foobar");
assert_eq!(format, None);

[src]

pub fn from_media_type(media_type: &str) -> Option<FileFormat>

Determines file format from a media type.

Examples

Detects from a media type:

use file_format::FileFormat;

let format = FileFormat::from_media_type("video/mp4");
assert_eq!(format, Some(FileFormat::Mp4));

Detects from an unknown media type:

use file_format::FileFormat;

let format = FileFormat::from_media_type("foo/bar");
assert_eq!(format, None);

[src]

pub fn from_file<P: AsRef<Path>>(path: P) -> Result<FileFormat, Error>

Determines file format from a file.

Examples

Basic usage:

use file_format::FileFormat;

let format = FileFormat::from_file("Cargo.toml")?;
assert_eq!(format, FileFormat::Text);

[src]

pub fn media_type(&self) -> &str

Returns the media type (formerly known as MIME type) of the file format.

Examples

Basic usage:

use file_format::FileFormat;

let format = FileFormat::Zstandard;
assert_eq!(format.media_type(), "application/zstd");

[src]

pub fn extensions(&self) -> Vec<&str>

Returns the extensions list of the file format.

Examples

Basic usage:

use file_format::FileFormat;

let format = FileFormat::Midi;
assert_eq!(format.extensions(), vec!["mid", "midi"]);

[src]

pub fn preferred_extension(&self) -> &str

Returns the preferred extension of the file format.

Examples

Basic usage:

use file_format::FileFormat;

let format = FileFormat::Wmv;
assert_eq!(format.preferred_extension(), "wmv");

Trait Implementations

[src]

impl Clone for FileFormat

[src]

fn clone(&self) -> FileFormat

Returns a copy of the value. Read more

1.0.0[src]

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

Performs copy-assignment from source. Read more

[src]

impl Debug for FileFormat

[src]

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

Formats the value using the given formatter. Read more

[src]

impl PartialEq<FileFormat> for FileFormat

[src]

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

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

1.0.0[src]

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

This method tests for !=.

[src]

impl StructuralPartialEq for FileFormat

Auto Trait Implementations

impl RefUnwindSafe for FileFormat

impl Send for FileFormat

impl Sync for FileFormat

impl Unpin for FileFormat

impl UnwindSafe for FileFormat

Blanket Implementations

[src]

impl<T> Any for T where
T: 'static + ?Sized,

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

impl<T> Borrow<T> for T where
T: ?Sized,

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

impl<T> BorrowMut<T> for T where
T: ?Sized,

[src]

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

impl<T, U> Into for T where
U: From<T>,

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

[src]

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

[src]

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

[src]

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

[src]

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

[src]

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

[src]

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Enum file_format::FileFormat[−][src]

Variants

Implementations

impl FileFormat

pub fn from_bytes(bytes: &[u8]) -> FileFormat

pub fn from_extension(extension: &str) -> Option<FileFormat>

pub fn from_media_type(media_type: &str) -> Option<FileFormat>

pub fn from_file<P: AsRef<Path>>(path: P) -> Result<FileFormat, Error>

pub fn media_type(&self) -> &str

pub fn extensions(&self) -> Vec<&str>

pub fn preferred_extension(&self) -> &str

Trait Implementations

impl Clone for FileFormat

fn clone(&self) -> FileFormat

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

impl Debug for FileFormat

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

impl PartialEq<FileFormat> for FileFormat

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

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

impl StructuralPartialEq for FileFormat

Auto Trait Implementations

impl RefUnwindSafe for FileFormat

impl Send for FileFormat

impl Sync for FileFormat

impl Unpin for FileFormat

impl UnwindSafe for FileFormat

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

pub fn from_bytes(bytes: &[u8 ]) -> FileFormat

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,