summaryrefslogtreecommitdiffstats
path: root/target/doc/mailparse/fn.parse_content_type.html
blob: b60539e45910f6984678950ea4444ef1087a97d5 (plain)
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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta name="generator" content="rustdoc">
    <meta name="description" content="API documentation for the Rust `parse_content_type` fn in crate `mailparse`.">
    <meta name="keywords" content="rust, rustlang, rust-lang, parse_content_type">

    <title>mailparse::parse_content_type - Rust</title>

    <link rel="stylesheet" type="text/css" href="../normalize.css">
    <link rel="stylesheet" type="text/css" href="../rustdoc.css"
          id="mainThemeStyle">
    
    <link rel="stylesheet" type="text/css" href="../dark.css">
    <link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle">
    <script src="../storage.js"></script>
    

    
    
</head>
<body class="rustdoc fn">
    <!--[if lte IE 8]>
    <div class="warning">
        This old browser is unsupported and will most likely display funky
        things.
    </div>
    <![endif]-->

    

    <nav class="sidebar">
        <div class="sidebar-menu">&#9776;</div>
        
        <div class="sidebar-elems"><p class='location'><a href='index.html'>mailparse</a></p><script>window.sidebarCurrent = {name: 'parse_content_type', ty: 'fn', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
    </nav>

    <div class="theme-picker">
        <button id="theme-picker" aria-label="Pick another theme!">
            <img src="../brush.svg" width="18" alt="Pick another theme!">
        </button>
        <div id="theme-choices"></div>
    </div>
    <script src="../theme.js"></script>
    <nav class="sub">
        <form class="search-form js-only">
            <div class="search-container">
                <input class="search-input" name="search"
                       autocomplete="off"
                       placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
                       type="search">
            </div>
        </form>
    </nav>

    <section id='main' class="content"><h1 class='fqn'><span class='in-band'>Function <a href='index.html'>mailparse</a>::<wbr><a class="fn" href=''>parse_content_type</a></span><span class='out-of-band'><span id='render-detail'>
                   <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
                       [<span class='inner'>&#x2212;</span>]
                   </a>
               </span><a class='srclink' href='../src/mailparse/lib.rs.html#554-566' title='goto source code'>[src]</a></span></h1><pre class='rust fn'>pub fn parse_content_type(header: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -&gt; <a class="struct" href="../mailparse/struct.ParsedContentType.html" title="struct mailparse::ParsedContentType">ParsedContentType</a></pre><div class='docblock'><p>Helper method to parse a header value as a Content-Type header. Note that
the returned object's <code>params</code> map will contain a charset key if a charset
was explicitly specified in the header; otherwise the <code>params</code> map will not
contain a charset key. Regardless, the <code>charset</code> field will contain a
charset - either the one explicitly specified or the default of &quot;us-ascii&quot;.</p>
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
<pre class="rust rust-example-rendered">
    <span class="kw">use</span> <span class="ident">mailparse</span>::{<span class="ident">parse_header</span>, <span class="ident">parse_content_type</span>};
    <span class="kw">let</span> (<span class="ident">parsed</span>, <span class="kw">_</span>) <span class="op">=</span> <span class="ident">parse_header</span>(
            <span class="string">b&quot;Content-Type: text/html; charset=foo; boundary=\&quot;quotes_are_removed\&quot;&quot;</span>)
        .<span class="ident">unwrap</span>();
    <span class="kw">let</span> <span class="ident">ctype</span> <span class="op">=</span> <span class="ident">parse_content_type</span>(<span class="kw-2">&amp;</span><span class="ident">parsed</span>.<span class="ident">get_value</span>().<span class="ident">unwrap</span>());
    <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">ctype</span>.<span class="ident">mimetype</span>, <span class="string">&quot;text/html&quot;</span>);
    <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">ctype</span>.<span class="ident">charset</span>, <span class="string">&quot;foo&quot;</span>);
    <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">ctype</span>.<span class="ident">params</span>.<span class="ident">get</span>(<span class="string">&quot;boundary&quot;</span>), <span class="prelude-val">Some</span>(<span class="kw-2">&amp;</span><span class="string">&quot;quotes_are_removed&quot;</span>.<span class="ident">to_string</span>()));
    <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">ctype</span>.<span class="ident">params</span>.<span class="ident">get</span>(<span class="string">&quot;charset&quot;</span>), <span class="prelude-val">Some</span>(<span class="kw-2">&amp;</span><span class="string">&quot;foo&quot;</span>.<span class="ident">to_string</span>()));</pre>

<pre class="rust rust-example-rendered">
    <span class="kw">use</span> <span class="ident">mailparse</span>::{<span class="ident">parse_header</span>, <span class="ident">parse_content_type</span>};
    <span class="kw">let</span> (<span class="ident">parsed</span>, <span class="kw">_</span>) <span class="op">=</span> <span class="ident">parse_header</span>(<span class="string">b&quot;Content-Type: bogus&quot;</span>).<span class="ident">unwrap</span>();
    <span class="kw">let</span> <span class="ident">ctype</span> <span class="op">=</span> <span class="ident">parse_content_type</span>(<span class="kw-2">&amp;</span><span class="ident">parsed</span>.<span class="ident">get_value</span>().<span class="ident">unwrap</span>());
    <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">ctype</span>.<span class="ident">mimetype</span>, <span class="string">&quot;bogus&quot;</span>);
    <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">ctype</span>.<span class="ident">charset</span>, <span class="string">&quot;us-ascii&quot;</span>);
    <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">ctype</span>.<span class="ident">params</span>.<span class="ident">get</span>(<span class="string">&quot;boundary&quot;</span>), <span class="prelude-val">None</span>);
    <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">ctype</span>.<span class="ident">params</span>.<span class="ident">get</span>(<span class="string">&quot;charset&quot;</span>), <span class="prelude-val">None</span>);</pre>

<pre class="rust rust-example-rendered">
    <span class="kw">use</span> <span class="ident">mailparse</span>::{<span class="ident">parse_header</span>, <span class="ident">parse_content_type</span>};
    <span class="kw">let</span> (<span class="ident">parsed</span>, <span class="kw">_</span>) <span class="op">=</span> <span class="ident">parse_header</span>(<span class="string">br#&quot;Content-Type: application/octet-stream;name=&quot;=?utf8?B?6L+O5ai255m95a+M576O?=&quot;;charset=&quot;utf8&quot;&quot;#</span>).<span class="ident">unwrap</span>();
    <span class="kw">let</span> <span class="ident">ctype</span> <span class="op">=</span> <span class="ident">parse_content_type</span>(<span class="kw-2">&amp;</span><span class="ident">parsed</span>.<span class="ident">get_value</span>().<span class="ident">unwrap</span>());
    <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">ctype</span>.<span class="ident">mimetype</span>, <span class="string">&quot;application/octet-stream&quot;</span>);
    <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">ctype</span>.<span class="ident">charset</span>, <span class="string">&quot;utf8&quot;</span>);
    <span class="macro">assert_eq</span><span class="macro">!</span>(<span class=&quo