File Type

File Type is a library that uses file signatures and file extensions to determine the type of file.

Signature, extension and media type data are provided by:

• Apache HTTPD
• IANA
• Linguist
• The National Archives PRONOM
• Wikidata

If you need a format that is not supported, please provide your submission to the PRONOM database and include the reference id when opening a feature request for this project.

Getting Started

Detect the file type from bytes:

use file_type::FileType;

let file_type = FileType::from_bytes(b"\xCA\xFE\xBA\xBE");
assert_eq!(file_type.extensions(), vec!["class"]);

Detect the file type from a file:

use file_type::FileType;
use std::path::Path;

#[tokio::main]
async fn main() {
    let file_path = Path::new("image.png");
    let file_type = FileType::try_from_file(file_path).await.expect("file type not found");
    assert_eq!(file_type.extensions(), vec!["png"]);
    assert_eq!(file_type.media_types(), vec!["image/png"]);
}

Detect the file type from a file synchronously:

use file_type::FileType;
use std::path::Path;

let file_path = Path::new("image.png");
let file_type = FileType::try_from_file_sync(file_path).expect("file type not found");
assert_eq!(file_type.extensions(), vec!["png"]);
assert_eq!(file_type.media_types(), vec!["image/png"]);

Feature flags

Name	Description	Default?
custom	Enables custom file types	Yes
httpd	Enables Apache HTTPD file types	No
iana	Enables IANA file types	No
linguist	Enables Linguist file types	No
pronom	Enables PRONOM file types	No
tokio	Enables using tokio for async	No
wikidata	Enables Wikidata file types	Yes

Supported File Types

List of supported file types

Safety

These crates use #![forbid(unsafe_code)] to ensure everything is implemented in 100% safe Rust.

Performance

Comparative performance determining file type from bytes

Comparative performance determining file type from extension

Comparative performance determining file type from media type

License

Licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or https://opensource.org/licenses/MIT)

Data is licensed under the following licenses:

• The HTTPD definitions are provided by the Apache Software Foundation under the Apache License 2.0.
• The IANA definitions are provided by the Internet Assigned Numbers Authority under the Creative Commons Zero (CC0) license.
• The PRONOM definitions are provided by The National Archives (UK) under the Open Government Licence.
• The Wikidata definitions are provided by the Wikidata project under the Creative Commons Zero (CC0) license.

Alternatives

If this crate does not meet your requirements, you may want to consider the following alternatives:

• file-format
• infer
• magic
• mime_guess

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.