suika_mime 0.1.2

A library for handling MIME types in the suika web stack
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

# Suika MIME: A Toy MIME Type Utility

**Important: This is a personal toy project, developed as an experiment and learning exercise.**

**As a toy project, its future development is uncertain. It may or may not receive future updates, maintenance, or bug fixes. Please do not use it in production environments.**

Suika MIME is a utility library for handling MIME types within the `Suika` web stack (also a toy project). It provides basic functionality for determining MIME types from file extensions or paths, primarily for understanding web asset serving and for experimental purposes.

The API is subject to change. This project is not thoroughly tested or hardened for real-world applications, and documentation may be basic.

## Features

-   Determine MIME type from file extension.
-   Determine MIME type from file path.
-   Basic support for common file types.
-   Intended as an illustrative example for simple MIME type handling.

## Usage

### Determining MIME Type from Extension

You can determine the MIME type based on a file extension using the `get_mime_type` function.

```rust
use suika_mime::get_mime_type;

let mime_type = get_mime_type("html");
assert_eq!(mime_type, "text/html".to_string());

let mime_type = get_mime_type("png");
assert_eq!(mime_type, "image/png".to_string());
```

### Determining MIME Type from File Path

You can determine the MIME type based on a file path using the `get_mime_type_from_path` function.

```rust
use suika_mime::get_mime_type_from_path;

let mime_type = get_mime_type_from_path("index.html");
assert_eq!(mime_type, "text/html".to_string());

let mime_type = get_mime_type_from_path("images/photo.png");
assert_eq!(mime_type, "image/png".to_string());
```

## Supported MIME Types

Suika MIME supports a range of common file types. This list is for reference and may not be exhaustive or perfectly up-to-date with external standards.

-   `html`, `htm`: `text/html`
-   `css`: `text/css`
-   `js`, `mjs`: `application/javascript`
-   `json`: `application/json`
-   `xml`: `application/xml`
-   `pdf`: `application/pdf`
-   `zip`: `application/zip`
-   `tar`: `application/x-tar`
-   `gz`: `application/gzip`
-   `bz2`: `application/x-bzip2`
-   `7z`: `application/x-7z-compressed`
-   `rar`: `application/vnd.rar`
-   `exe`: `application/vnd.microsoft.portable-executable`
-   `msi`: `application/x-msdownload`
-   `bin`, `dll`, `iso`, `dmg`: `application/octet-stream`
-   `png`: `image/png`
-   `jpg`, `jpeg`: `image/jpeg`
-   `gif`: `image/gif`
-   `svg`: `image/svg+xml`
-   `bmp`: `image/bmp`
-   `ico`: `image/x-icon`
-   `tiff`, `tif`: `image/tiff`
-   `webp`: `image/webp`
-   `mp3`: `audio/mpeg`
-   `wav`: `audio/wav`
-   `ogg`: `audio/ogg`
-   `flac`: `audio/flac`
-   `aac`: `audio/aac`
-   `mp4`: `video/mp4`
-   `m4v`: `video/x-m4v`
-   `mkv`: `video/x-matroska`
-   `webm`: `video/webm`
-   `avi`: `video/x-msvideo`
-   `mov`: `video/quicktime`
-   `wmv`: `video/x-ms-wmv`
-   `txt`: `text/plain`
-   `csv`: `text/csv`
-   `md`: `text/markdown`
-   `rtf`: `application/rtf`
-   `odt`: `application/vnd.oasis.opendocument.text`
-   `ods`: `application/vnd.oasis.opendocument.spreadsheet`
-   `odp`: `application/vnd.oasis.opendocument.presentation`
-   `doc`: `application/msword`
-   `docx`:
    `application/vnd.openxmlformats-officedocument.wordprocessingml.document`
-   `xls`: `application/vnd.ms-excel`
-   `xlsx`: `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`
-   `ppt`: `application/vnd.ms-powerpoint`
-   `pptx`:
    `application/vnd.openxmlformats-officedocument.presentationml.presentation`