file_type 0.7.1

File type detector
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125

# file_type

[![ci](https://github.com/theseus-rs/file-type/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/theseus-rs/file-type/actions/workflows/ci.yml)
[![Documentation](https://docs.rs/file_type/badge.svg)](https://docs.rs/file_type)
[![Code Coverage](https://codecov.io/gh/theseus-rs/file-type/branch/main/graph/badge.svg)](https://codecov.io/gh/theseus-rs/file-type)
[![Benchmarks](https://img.shields.io/badge/%F0%9F%90%B0_bencher-enabled-6ec241)](https://bencher.dev/perf/theseus-rs-file-type)
[![Latest version](https://img.shields.io/crates/v/file_type.svg)](https://crates.io/crates/file_type)
[![License](https://img.shields.io/crates/l/file_type)](https://github.com/theseus-rs/file-type#license)
[![Semantic Versioning](https://img.shields.io/badge/%E2%9A%99%EF%B8%8F_SemVer-2.0.0-blue)](https://semver.org/spec/v2.0.0.html)

## Getting Started

File types are determined by examining a file or bytes against known file
signatures and file extensions.

Signature, extension and media type data are provided by:

* [Apache HTTPD](https://github.com/apache/httpd/blob/trunk/docs/conf/mime.types)
* [IANA](https://www.iana.org/assignments/media-types/media-types.xml)
* [Linguist](https://github.com/github-linguist/linguist/blob/main/lib/linguist/languages.yml)
* [The National Archives PRONOM](https://www.nationalarchives.gov.uk/pronom/)
* [Wikidata](https://www.wikidata.org/wiki/Wikidata:WikiProject_Informatics/Structures/File_formats/List)

# Example

Detect the file type from bytes:

```rust
use file_type::FileType;

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

Retrieve a file type from an extension:

```rust
use file_type::FileType;

let file_types = FileType::from_extension("png");
let file_type = file_types.first().expect("file format");
assert_eq!(file_type.media_types(), vec!["image/png"]);
```

Retrieve a file type from a media type:

```rust
use file_type::FileType;

let file_types = FileType::from_media_type("image/png");
let file_type = file_types.first().expect("file format");
assert_eq!(file_type.extensions(), vec!["png"]);
```

## Feature flags

| Name       | Description                                                                                                                | Default? |
|------------|----------------------------------------------------------------------------------------------------------------------------|----------|
| `custom`   | Enables custom file types                                                                                                  | Yes      |
| `httpd`    | Enables [Apache HTTPD](https://github.com/apache/httpd/blob/trunk/docs/conf/mime.types) file types                         | No       |
| `iana`     | Enables [IANA](https://www.iana.org/assignments/media-types/media-types.xml) file types                                    | No       |
| `linguist` | Enables [Linguist](https://github.com/github-linguist/linguist/blob/main/lib/linguist/languages.yml) file types            | No       |
| `pronom`   | Enables [PRONOM](https://www.nationalarchives.gov.uk/PRONOM) file types                                                    | No       |
| `std`      | Enables support for the Rust standard library                                                                              | Yes      |
| `wikidata` | Enables [Wikidata](https://www.wikidata.org/wiki/Wikidata:WikiProject_Informatics/Structures/File_formats/List) file types | Yes      |

## Supported File Types

[List of supported file types](https://github.com/theseus-rs/file-type/blob/main/FILETYPES.md)

## Safety

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

## Performance

### Comparative performance determining file type from bytes

<a href="https://bencher.dev/perf/theseus-rs-file-type?lower_value=false&upper_value=false&lower_boundary=false&upper_boundary=false&x_axis=date_time&branches=e6bda651-ab44-4c6b-8db6-5b495b43ea40&testbeds=4927da7e-2d56-48e6-a579-d78b3787c104&benchmarks=bdf821ff-e1df-478f-923c-6dd28c4509e1%2C709db97a-d220-48b7-996a-2ee7cf2944bd%2Cfa2bef70-dfd4-4834-bbc9-eb3e30af67e5&measures=670fcc74-764a-40b6-8cd2-93076b6cc17d&start_time=1736357094394&tab=plots&plots_search=d92fa224-61b5-42b3-8643-c40fa14f8c11&key=true&reports_per_page=4&branches_per_page=8&testbeds_per_page=8&benchmarks_per_page=8&plots_per_page=8&reports_page=1&branches_page=1&testbeds_page=1&benchmarks_page=1&plots_page=1&utm_medium=share&utm_source=bencher&utm_content=img&utm_campaign=perf%2Bimg&utm_term=theseus-rs-file-type"><img src="https://api.bencher.dev/v0/projects/theseus-rs-file-type/perf/img?branches=e6bda651-ab44-4c6b-8db6-5b495b43ea40&heads=&testbeds=4927da7e-2d56-48e6-a579-d78b3787c104&benchmarks=bdf821ff-e1df-478f-923c-6dd28c4509e1%2C709db97a-d220-48b7-996a-2ee7cf2944bd%2Cfa2bef70-dfd4-4834-bbc9-eb3e30af67e5&measures=670fcc74-764a-40b6-8cd2-93076b6cc17d&start_time=1736357094394" title="theseus-rs/file-type" alt="theseus-rs/file-type - Bencher" /></a>

### Comparative performance determining file type from extension

<a href="https://bencher.dev/perf/theseus-rs-file-type?lower_value=false&upper_value=false&lower_boundary=false&upper_boundary=false&x_axis=date_time&branches=e6bda651-ab44-4c6b-8db6-5b495b43ea40&testbeds=4927da7e-2d56-48e6-a579-d78b3787c104&benchmarks=5ea43253-b368-4799-b6bd-a08556196456%2C2328df4a-c516-403c-bc84-2b7c7ee0a0fa&measures=670fcc74-764a-40b6-8cd2-93076b6cc17d&start_time=1736357094393&tab=plots&plots_search=f1500077-7e42-4ded-b658-8dd1f35205d1&key=true&reports_per_page=4&branches_per_page=8&testbeds_per_page=8&benchmarks_per_page=8&plots_per_page=8&reports_page=1&branches_page=1&testbeds_page=1&benchmarks_page=1&plots_page=1&utm_medium=share&utm_source=bencher&utm_content=img&utm_campaign=perf%2Bimg&utm_term=theseus-rs-file-type"><img src="https://api.bencher.dev/v0/projects/theseus-rs-file-type/perf/img?branches=e6bda651-ab44-4c6b-8db6-5b495b43ea40&heads=&testbeds=4927da7e-2d56-48e6-a579-d78b3787c104&benchmarks=5ea43253-b368-4799-b6bd-a08556196456%2C2328df4a-c516-403c-bc84-2b7c7ee0a0fa&measures=670fcc74-764a-40b6-8cd2-93076b6cc17d&start_time=1736357094393" title="theseus-rs/file-type" alt="theseus-rs/file-type - Bencher" /></a>

### Comparative performance determining file type from media type

<a href="https://bencher.dev/perf/theseus-rs-file-type?lower_value=false&upper_value=false&lower_boundary=false&upper_boundary=false&x_axis=date_time&branches=e6bda651-ab44-4c6b-8db6-5b495b43ea40&testbeds=4927da7e-2d56-48e6-a579-d78b3787c104&benchmarks=65468a2b-b06d-4c15-9491-694934dbd036%2C7d89adc9-2bf0-4449-9923-73e1ea4eabd8&measures=670fcc74-764a-40b6-8cd2-93076b6cc17d&start_time=1736357094389&tab=plots&plots_search=f564a523-53a7-491f-a650-7097249dc2cb&key=true&reports_per_page=4&branches_per_page=8&testbeds_per_page=8&benchmarks_per_page=8&plots_per_page=8&reports_page=1&branches_page=1&testbeds_page=1&benchmarks_page=1&plots_page=1&utm_medium=share&utm_source=bencher&utm_content=img&utm_campaign=perf%2Bimg&utm_term=theseus-rs-file-type"><img src="https://api.bencher.dev/v0/projects/theseus-rs-file-type/perf/img?branches=e6bda651-ab44-4c6b-8db6-5b495b43ea40&heads=&testbeds=4927da7e-2d56-48e6-a579-d78b3787c104&benchmarks=65468a2b-b06d-4c15-9491-694934dbd036%2C7d89adc9-2bf0-4449-9923-73e1ea4eabd8&measures=670fcc74-764a-40b6-8cd2-93076b6cc17d&start_time=1736357094389" title="theseus-rs/file-type" alt="theseus-rs/file-type - Bencher" /></a>

## License

Licensed under either of

* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or https://www.apache.org/licenses/LICENSE-2.0)
* MIT license ([LICENSE-MIT](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](https://github.com/apache/httpd/blob/trunk/LICENSE).
* The IANA definitions are provided by the Internet Assigned Numbers Authority under the
  [Creative Commons Zero (CC0)](https://www.iana.org/help/licensing-terms) license.
* The PRONOM definitions are provided by The National Archives (UK) under the
  [Open Government Licence](https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/).
* The Wikidata definitions are provided by the Wikidata project under the
  [Creative Commons Zero (CC0)](https://www.wikidata.org/wiki/Wikidata:Licensing) license.

## 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.

<a href="https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/theseus-rs/file-type">
<img
  src="https://img.shields.io/static/v1?label=VSCode%20Development%20Container&logo=visualstudiocode&message=Open&color=orange"
  alt="VSCode Development Container"
/>
</a>
<br/>
<a href="https://github.dev/theseus-rs/file-type">
<img
  src="https://img.shields.io/static/v1?label=GitHub%20Codespaces&logo=github&message=Open&color=orange"
  alt="GitHub Codespaces"
/>
</a>