file_type 0.0.0

File type dector
Documentation

file_type

ci Documentation Code Coverage Benchmarks Latest version License Semantic Versioning

Getting Started

A file type. The file type is determined by examining the file or bytes against known file signatures and file extensions.

Additional information on PRONOM file types can be found at The National Archives

Example

Detect a Java class file from bytes:

use file_type::FileType;

let file_type = FileType::from_bytes(b"\xCA\xFE\xBA\xBE");
assert_eq!(file_type.id(), "x-fmt/415");
assert_eq!(file_type.name(), "Java Class File");
assert_eq!(file_type.media_types(), Vec::<String>::new());
assert!(file_type.extensions(), vec!["class".to_string()]);

Detect text from bytes:

use file_type::FileType;

let file_type = FileType::from_bytes(b"hello, world\n");
assert_eq!(file_type.id(), "custom/1");
assert_eq!(file_type.name(), "Text");
assert_eq!(file_type.media_types(), Some("text/plain"));
assert_eq!(file_type.extensions(), Vec::<String>::new());

Safety

This crate uses #![forbid(unsafe_code)] to ensure everything is implemented in 100% safe Rust.

License

Licensed under either of

AND

The PRONOM definitions are provided by The National Archives (UK) under the Open Government Licence.

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.