summaryrefslogtreecommitdiff
path: root/devdocs/go/mime%2Fquotedprintable%2Findex.html
blob: 9ca177625b898cfad5eb274e871052a350866b75 (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
<h1> Package quotedprintable  </h1>     <ul id="short-nav">
<li><code>import "mime/quotedprintable"</code></li>
<li><a href="#pkg-overview" class="overviewLink">Overview</a></li>
<li><a href="#pkg-index" class="indexLink">Index</a></li>
<li><a href="#pkg-examples" class="examplesLink">Examples</a></li>
</ul>     <h2 id="pkg-overview">Overview </h2> <p>Package quotedprintable implements quoted-printable encoding as specified by RFC 2045. </p>     <h2 id="pkg-index">Index </h2>  <ul id="manual-nav">
<li><a href="#Reader">type Reader</a></li>
<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>
<li><a href="#Writer">type Writer</a></li>
<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> <div id="pkg-examples"> <h3>Examples</h3>  <dl> <dd><a class="exampleLink" href="#example_NewReader">NewReader</a></dd> <dd><a class="exampleLink" href="#example_NewWriter">NewWriter</a></dd> </dl> </div> <h3>Package files</h3> <p>  <span>reader.go</span> <span>writer.go</span>  </p>   <h2 id="Reader">type <span>Reader</span>  <span title="Added in Go 1.5">1.5</span> </h2> <p>Reader is a quoted-printable decoder. </p>
<pre data-language="go">type Reader struct {
    // contains filtered or unexported fields
}
</pre> <h3 id="NewReader">func <span>NewReader</span>  <span title="Added in Go 1.5">1.5</span> </h3> <pre data-language="go">func NewReader(r io.Reader) *Reader</pre> <p>NewReader returns a quoted-printable reader, decoding from r. </p>   <h4 id="example_NewReader"> <span class="text">Example</span>
</h4> <p>Code:</p> <pre class="code" data-language="go">for _, s := range []string{
    `=48=65=6C=6C=6F=2C=20=47=6F=70=68=65=72=73=21`,
    `invalid escape: &lt;b style="font-size: 200%"&gt;hello&lt;/b&gt;`,
    "Hello, Gophers! This symbol will be unescaped: =3D and this will be written in =\r\none line.",
} {
    b, err := io.ReadAll(quotedprintable.NewReader(strings.NewReader(s)))
    fmt.Printf("%s %v\n", b, err)
}
</pre> <p>Output:</p> <pre class="output" data-language="go">Hello, Gophers! &lt;nil&gt;
invalid escape: &lt;b style="font-size: 200%"&gt;hello&lt;/b&gt; &lt;nil&gt;
Hello, Gophers! This symbol will be unescaped: = and this will be written in one line. &lt;nil&gt;
</pre>   <h3 id="Reader.Read">func (*Reader) <span>Read</span>  <span title="Added in Go 1.5">1.5</span> </h3> <pre data-language="go">func (r *Reader) Read(p []byte) (n int, err error)</pre> <p>Read reads and decodes quoted-printable data from the underlying reader. </p>
<h2 id="Writer">type <span>Writer</span>  <span title="Added in Go 1.5">1.5</span> </h2> <p>A Writer is a quoted-printable writer that implements io.WriteCloser. </p>
<pre data-language="go">type Writer struct {
    // Binary mode treats the writer's input as pure binary and processes end of
    // line bytes as binary data.
    Binary bool
    // contains filtered or unexported fields
}
</pre> <h3 id="NewWriter">func <span>NewWriter</span>  <span title="Added in Go 1.5">1.5</span> </h3> <pre data-language="go">func NewWriter(w io.Writer) *Writer</pre> <p>NewWriter returns a new Writer that writes to w. </p>   <h4 id="example_NewWriter"> <span class="text">Example</span>
</h4> <p>Code:</p> <pre class="code" data-language="go">w := quotedprintable.NewWriter(os.Stdout)
w.Write([]byte("These symbols will be escaped: = \t"))
w.Close()

</pre> <p>Output:</p> <pre class="output" data-language="go">These symbols will be escaped: =3D =09
</pre>   <h3 id="Writer.Close">func (*Writer) <span>Close</span>  <span title="Added in Go 1.5">1.5</span> </h3> <pre data-language="go">func (w *Writer) Close() error</pre> <p>Close closes the Writer, flushing any unwritten data to the underlying io.Writer, but does not close the underlying io.Writer. </p>
<h3 id="Writer.Write">func (*Writer) <span>Write</span>  <span title="Added in Go 1.5">1.5</span> </h3> <pre data-language="go">func (w *Writer) Write(p []byte) (n int, err error)</pre> <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 class="_attribution">
  <p class="_attribution-p">
    &copy; Google, Inc.<br>Licensed under the Creative Commons Attribution License 3.0.<br>
    <a href="http://golang.org/pkg/mime/quotedprintable/" class="_attribution-link">http://golang.org/pkg/mime/quotedprintable/</a>
  </p>
</div>