diff options
| author | Craig Jennings <c@cjennings.net> | 2024-04-07 13:41:34 -0500 |
|---|---|---|
| committer | Craig Jennings <c@cjennings.net> | 2024-04-07 13:41:34 -0500 |
| commit | 754bbf7a25a8dda49b5d08ef0d0443bbf5af0e36 (patch) | |
| tree | f1190704f78f04a2b0b4c977d20fe96a828377f1 /devdocs/go/mime%2Fquotedprintable%2Findex.html | |
new repository
Diffstat (limited to 'devdocs/go/mime%2Fquotedprintable%2Findex.html')
| -rw-r--r-- | devdocs/go/mime%2Fquotedprintable%2Findex.html | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/devdocs/go/mime%2Fquotedprintable%2Findex.html b/devdocs/go/mime%2Fquotedprintable%2Findex.html new file mode 100644 index 00000000..9ca17762 --- /dev/null +++ b/devdocs/go/mime%2Fquotedprintable%2Findex.html @@ -0,0 +1,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: <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 := 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! <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> <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"> + © 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> |
