-
Notifications
You must be signed in to change notification settings - Fork 148
/
Copy pathmime_quotedprintable.htm
227 lines (127 loc) · 10.9 KB
/
mime_quotedprintable.htm
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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
<!DOCTYPE html>
<html lang="en">
<head profile="http://a9.com/-/spec/opensearch/1.1/">
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link href="../assets/site.css" rel="stylesheet">
<title>mime/quotedprintable</title>
<meta name="twitter:title" content="Package quotedprintable">
<meta property="og:title" content="Package quotedprintable">
<meta name="description" content="Package quotedprintable implements quoted-printable encoding as specified by RFC 2045.">
<meta name="twitter:description" content="Package quotedprintable implements quoted-printable encoding as specified by RFC 2045.">
<meta property="og:description" content="Package quotedprintable implements quoted-printable encoding as specified by RFC 2045.">
<meta name="twitter:card" content="summary">
<meta name="twitter:site" content="@golang">
</head>
<body>
<div class="container">
<h2 id="pkg-overview">package quotedprintable</h2>
<p><code>import "mime/quotedprintable"</code>
<p>
Package quotedprintable implements quoted-printable encoding as specified by
<a href="http://tools.ietf.org/html/rfc2045">RFC 2045</a>.</p>
<h3 id="pkg-index" class="section-header">Index <a class="permalink" href="#pkg-index">¶</a></h3>
<ul class="list-unstyled">
<li><a href="#Reader">type Reader</a></li>
<ul>
<li><a href="#NewReader">func NewReader(r io.Reader) *Reader</a></li>
<li><a href="#Reader.Read">func (r *Reader) Read(p []byte) (n int, err error)</a></li>
</ul>
<li><a href="#Writer">type Writer</a></li>
<ul>
<li><a href="#NewWriter">func NewWriter(w io.Writer) *Writer</a></li>
<li><a href="#Writer.Close">func (w *Writer) Close() error</a></li><li><a href="#Writer.Write">func (w *Writer) Write(p []byte) (n int, err error)</a></li>
</ul>
</ul>
<h4 id="pkg-examples">Examples <a class="permalink" href="#pkg-examples">¶</a></h4>
<ul class="list-unstyled">
<li><a href="#example-NewReader" onclick="$('#ex-NewReader').addClass('in').removeClass('collapse').height('auto')">NewReader</a></li><li><a href="#example-NewWriter" onclick="$('#ex-NewWriter').addClass('in').removeClass('collapse').height('auto')">NewWriter</a></li>
</ul>
<h4 id="pkg-files">
<a href="https://github.com/golang/go/blob/master/src/mime/quotedprintable/">Package Files</a>
<a class="permalink" href="#pkg-files">¶</a>
</h4>
<p><a href="https://github.com/golang/go/blob/master/src/mime/quotedprintable/reader.go">reader.go</a> <a href="https://github.com/golang/go/blob/master/src/mime/quotedprintable/writer.go">writer.go</a> </p>
<h3 id="Reader" data-kind="t">type <a title="View Source" href="https://github.com/golang/go/blob/master/src/mime/quotedprintable/reader.go#L17">Reader</a> <a class="permalink" href="#Reader">¶</a> <a class="uses" title="List Uses of This Type" href="https://sourcegraph.com/-/godoc/refs?def=Reader&pkg=mime%2Fquotedprintable&repo=">Uses</a></h3>
<div class="decl" data-kind="d"><a title="View Source" href="https://github.com/golang/go/blob/master/src/mime/quotedprintable/reader.go#L17">❖</a><pre>type Reader struct {
<span class="com">// contains filtered or unexported fields</span>
}</pre></div><p>
Reader is a quoted-printable decoder.
</p>
<h4 id="NewReader" data-kind="f">func <a title="View Source" href="https://github.com/golang/go/blob/master/src/mime/quotedprintable/reader.go#L24">NewReader</a> <a class="permalink" href="#NewReader">¶</a> <a class="uses" title="List Function Callers" href="https://sourcegraph.com/-/godoc/refs?def=NewReader&pkg=mime%2Fquotedprintable&repo=">Uses</a></h4>
<div class="funcdecl decl"><a title="View Source" href="https://github.com/golang/go/blob/master/src/mime/quotedprintable/reader.go#L24">❖</a><pre>func NewReader(r <a href="/io">io</a>.<a href="/io#Reader">Reader</a>) *<a href="#Reader">Reader</a></pre></div><p>
NewReader returns a quoted-printable reader, decoding from r.
</p>
<div class="panel-group">
<div class="panel panel-default" id="example-NewReader">
<div class="panel-heading"><a class="accordion-toggle" data-toggle="collapse" href="#ex-NewReader">Example</a></div>
<div id="ex-NewReader" class="panel-collapse collapse"><div class="panel-body">
<p>Code:<span class="pull-right"><a href="?play=NewReader">play</a> </span>
<pre>for _, s := range []string{
`=48=65=6C=6C=6F=2C=20=47=6F=70=68=65=72=73=21`,
`invalid escape: <b style="font-size: 200%">hello</b>`,
"Hello, Gophers! This symbol will be unescaped: =3D and this will be written in =\r\none line.",
} {
b, err := ioutil.ReadAll(quotedprintable.NewReader(strings.NewReader(s)))
fmt.Printf("%s %v\n", b, err)
}</pre>
<p>Output:<pre>Hello, Gophers! <nil>
invalid escape: <b style="font-size: 200%">hello</b> <nil>
Hello, Gophers! This symbol will be unescaped: = and this will be written in one line. <nil>
</pre>
</div></div>
</div>
</div>
<h4 id="Reader.Read" data-kind="m">func (*Reader) <a title="View Source" href="https://github.com/golang/go/blob/master/src/mime/quotedprintable/reader.go#L72">Read</a> <a class="permalink" href="#Reader.Read">¶</a> <a class="uses" title="List Method Callers" href="https://sourcegraph.com/-/godoc/refs?def=Reader%2FRead&pkg=mime%2Fquotedprintable&repo=">Uses</a></h4>
<div class="funcdecl decl"><a title="View Source" href="https://github.com/golang/go/blob/master/src/mime/quotedprintable/reader.go#L72">❖</a><pre>func (r *<a href="#Reader">Reader</a>) Read(p []<a href="/builtin#byte">byte</a>) (n <a href="/builtin#int">int</a>, err <a href="/builtin#error">error</a>)</pre></div><p>
Read reads and decodes quoted-printable data from the underlying reader.
</p>
<h3 id="Writer" data-kind="t">type <a title="View Source" href="https://github.com/golang/go/blob/master/src/mime/quotedprintable/writer.go#L12">Writer</a> <a class="permalink" href="#Writer">¶</a> <a class="uses" title="List Uses of This Type" href="https://sourcegraph.com/-/godoc/refs?def=Writer&pkg=mime%2Fquotedprintable&repo=">Uses</a></h3>
<div class="decl" data-kind="d"><a title="View Source" href="https://github.com/golang/go/blob/master/src/mime/quotedprintable/writer.go#L12">❖</a><pre>type Writer struct {
<span class="com">// Binary mode treats the writer's input as pure binary and processes end of
// line bytes as binary data.</span>
<span id="Writer.Binary">Binary</span> <a href="/builtin#bool">bool</a>
<span class="com">// contains filtered or unexported fields</span>
}</pre></div><p>
A Writer is a quoted-printable writer that implements io.WriteCloser.
</p>
<h4 id="NewWriter" data-kind="f">func <a title="View Source" href="https://github.com/golang/go/blob/master/src/mime/quotedprintable/writer.go#L24">NewWriter</a> <a class="permalink" href="#NewWriter">¶</a> <a class="uses" title="List Function Callers" href="https://sourcegraph.com/-/godoc/refs?def=NewWriter&pkg=mime%2Fquotedprintable&repo=">Uses</a></h4>
<div class="funcdecl decl"><a title="View Source" href="https://github.com/golang/go/blob/master/src/mime/quotedprintable/writer.go#L24">❖</a><pre>func NewWriter(w <a href="/io">io</a>.<a href="/io#Writer">Writer</a>) *<a href="#Writer">Writer</a></pre></div><p>
NewWriter returns a new Writer that writes to w.
</p>
<div class="panel-group">
<div class="panel panel-default" id="example-NewWriter">
<div class="panel-heading"><a class="accordion-toggle" data-toggle="collapse" href="#ex-NewWriter">Example</a></div>
<div id="ex-NewWriter" class="panel-collapse collapse"><div class="panel-body">
<p>Code:<span class="pull-right"><a href="?play=NewWriter">play</a> </span>
<pre>w := quotedprintable.NewWriter(os.Stdout)
w.Write([]byte("These symbols will be escaped: = \t"))
w.Close()</pre>
<p>Output:<pre>These symbols will be escaped: =3D =09
</pre>
</div></div>
</div>
</div>
<h4 id="Writer.Close" data-kind="m">func (*Writer) <a title="View Source" href="https://github.com/golang/go/blob/master/src/mime/quotedprintable/writer.go#L67">Close</a> <a class="permalink" href="#Writer.Close">¶</a> <a class="uses" title="List Method Callers" href="https://sourcegraph.com/-/godoc/refs?def=Writer%2FClose&pkg=mime%2Fquotedprintable&repo=">Uses</a></h4>
<div class="funcdecl decl"><a title="View Source" href="https://github.com/golang/go/blob/master/src/mime/quotedprintable/writer.go#L67">❖</a><pre>func (w *<a href="#Writer">Writer</a>) Close() <a href="/builtin#error">error</a></pre></div><p>
Close closes the Writer, flushing any unwritten data to the underlying
io.Writer, but does not close the underlying io.Writer.
</p>
<h4 id="Writer.Write" data-kind="m">func (*Writer) <a title="View Source" href="https://github.com/golang/go/blob/master/src/mime/quotedprintable/writer.go#L31">Write</a> <a class="permalink" href="#Writer.Write">¶</a> <a class="uses" title="List Method Callers" href="https://sourcegraph.com/-/godoc/refs?def=Writer%2FWrite&pkg=mime%2Fquotedprintable&repo=">Uses</a></h4>
<div class="funcdecl decl"><a title="View Source" href="https://github.com/golang/go/blob/master/src/mime/quotedprintable/writer.go#L31">❖</a><pre>func (w *<a href="#Writer">Writer</a>) Write(p []<a href="/builtin#byte">byte</a>) (n <a href="/builtin#int">int</a>, err <a href="/builtin#error">error</a>)</pre></div><p>
Write encodes p using quoted-printable encoding and writes it to the
underlying io.Writer. It limits line length to 76 characters. The encoded
bytes are not necessarily flushed until the Writer is closed.
</p>
<div id="x-footer" class="clearfix">
<div class="container">
<a href="http://studygolang.com/" target="_blank">Go语言中文网</a>
<span class="text-muted">|</span> <a href="http://golang.org/" target="_blank">Go Language</a>
<span class="pull-right"><a href="#">Back to top</a></span>
</div>
</div>
<script src="../assets/jquery-2.0.3.min.js"></script>
<script src="../assets/bootstrap.min.js"></script>
<script src="../assets/site.js"></script>
</body>
</html>