You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

338 lines
9.6 KiB

8 years ago
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1">
  6. <meta name="theme-color" content="#375EAB">
  7. <title>quotedprintable - The Go Programming Language</title>
  8. <link type="text/css" rel="stylesheet" href="../../../lib/godoc/style.css">
  9. <link rel="stylesheet" href="../../../lib/godoc/jquery.treeview.css">
  10. <script type="text/javascript">window.initFuncs = [];</script>
  11. </head>
  12. <body>
  13. <div id='lowframe' style="position: fixed; bottom: 0; left: 0; height: 0; width: 100%; border-top: thin solid grey; background-color: white; overflow: auto;">
  14. ...
  15. </div><!-- #lowframe -->
  16. <div id="topbar" class="wide"><div class="container">
  17. <div class="top-heading" id="heading-wide"><a href="http://localhost:6060/">The Go Programming Language</a></div>
  18. <div class="top-heading" id="heading-narrow"><a href="http://localhost:6060/">Go</a></div>
  19. <a href="index.html#" id="menu-button"><span id="menu-button-arrow">&#9661;</span></a>
  20. <form method="GET" action="http://localhost:6060/search">
  21. <div id="menu">
  22. <a href="http://localhost:6060/doc/">Documents</a>
  23. <a href="http://localhost:6060/pkg/">Packages</a>
  24. <a href="http://localhost:6060/project/">The Project</a>
  25. <a href="http://localhost:6060/help/">Help</a>
  26. <a href="http://localhost:6060/blog/">Blog</a>
  27. <input type="text" id="search" name="q" class="inactive" value="Search" placeholder="Search">
  28. </div>
  29. </form>
  30. </div></div>
  31. <div id="page" class="wide">
  32. <div class="container">
  33. <h1>Package quotedprintable</h1>
  34. <div id="nav"></div>
  35. <!--
  36. Copyright 2009 The Go Authors. All rights reserved.
  37. Use of this source code is governed by a BSD-style
  38. license that can be found in the LICENSE file.
  39. -->
  40. <!--
  41. Note: Static (i.e., not template-generated) href and id
  42. attributes start with "pkg-" to make it impossible for
  43. them to conflict with generated attributes (some of which
  44. correspond to Go identifiers).
  45. -->
  46. <script type='text/javascript'>
  47. document.ANALYSIS_DATA = null;
  48. document.CALLGRAPH = null;
  49. </script>
  50. <div id="short-nav">
  51. <dl>
  52. <dd><code>import "mime/quotedprintable"</code></dd>
  53. </dl>
  54. <dl>
  55. <dd><a href="index.html#pkg-overview" class="overviewLink">Overview</a></dd>
  56. <dd><a href="index.html#pkg-index" class="indexLink">Index</a></dd>
  57. </dl>
  58. </div>
  59. <!-- The package's Name is printed as title by the top-level template -->
  60. <div id="pkg-overview" class="toggleVisible">
  61. <div class="collapsed">
  62. <h2 class="toggleButton" title="Click to show Overview section">Overview ▹</h2>
  63. </div>
  64. <div class="expanded">
  65. <h2 class="toggleButton" title="Click to hide Overview section">Overview ▾</h2>
  66. <p>
  67. Package quotedprintable implements quoted-printable encoding as specified by
  68. RFC 2045.
  69. </p>
  70. </div>
  71. </div>
  72. <div id="pkg-index" class="toggleVisible">
  73. <div class="collapsed">
  74. <h2 class="toggleButton" title="Click to show Index section">Index ▹</h2>
  75. </div>
  76. <div class="expanded">
  77. <h2 class="toggleButton" title="Click to hide Index section">Index ▾</h2>
  78. <!-- Table of contents for API; must be named manual-nav to turn off auto nav. -->
  79. <div id="manual-nav">
  80. <dl>
  81. <dd><a href="index.html#Reader">type Reader</a></dd>
  82. <dd>&nbsp; &nbsp; <a href="index.html#NewReader">func NewReader(r io.Reader) *Reader</a></dd>
  83. <dd>&nbsp; &nbsp; <a href="index.html#Reader.Read">func (r *Reader) Read(p []byte) (n int, err error)</a></dd>
  84. <dd><a href="index.html#Writer">type Writer</a></dd>
  85. <dd>&nbsp; &nbsp; <a href="index.html#NewWriter">func NewWriter(w io.Writer) *Writer</a></dd>
  86. <dd>&nbsp; &nbsp; <a href="index.html#Writer.Close">func (w *Writer) Close() error</a></dd>
  87. <dd>&nbsp; &nbsp; <a href="index.html#Writer.Write">func (w *Writer) Write(p []byte) (n int, err error)</a></dd>
  88. </dl>
  89. </div><!-- #manual-nav -->
  90. <h4>Package files</h4>
  91. <p>
  92. <span style="font-size:90%">
  93. <a href="http://localhost:6060/src/mime/quotedprintable/reader.go">reader.go</a>
  94. <a href="http://localhost:6060/src/mime/quotedprintable/writer.go">writer.go</a>
  95. </span>
  96. </p>
  97. </div><!-- .expanded -->
  98. </div><!-- #pkg-index -->
  99. <div id="pkg-callgraph" class="toggle" style="display: none">
  100. <div class="collapsed">
  101. <h2 class="toggleButton" title="Click to show Internal Call Graph section">Internal call graph ▹</h2>
  102. </div> <!-- .expanded -->
  103. <div class="expanded">
  104. <h2 class="toggleButton" title="Click to hide Internal Call Graph section">Internal call graph ▾</h2>
  105. <p>
  106. In the call graph viewer below, each node
  107. is a function belonging to this package
  108. and its children are the functions it
  109. calls&mdash;perhaps dynamically.
  110. </p>
  111. <p>
  112. The root nodes are the entry points of the
  113. package: functions that may be called from
  114. outside the package.
  115. There may be non-exported or anonymous
  116. functions among them if they are called
  117. dynamically from another package.
  118. </p>
  119. <p>
  120. Click a node to visit that function's source code.
  121. From there you can visit its callers by
  122. clicking its declaring <code>func</code>
  123. token.
  124. </p>
  125. <p>
  126. Functions may be omitted if they were
  127. determined to be unreachable in the
  128. particular programs or tests that were
  129. analyzed.
  130. </p>
  131. <!-- Zero means show all package entry points. -->
  132. <ul style="margin-left: 0.5in" id="callgraph-0" class="treeview"></ul>
  133. </div>
  134. </div> <!-- #pkg-callgraph -->
  135. <h2 id="Reader">type <a href="http://localhost:6060/src/mime/quotedprintable/reader.go?s=362:485#L7">Reader</a></h2>
  136. <pre>type Reader struct {
  137. <span class="comment">// contains filtered or unexported fields</span>
  138. }</pre>
  139. <p>
  140. Reader is a quoted-printable decoder.
  141. </p>
  142. <h3 id="NewReader">func <a href="http://localhost:6060/src/mime/quotedprintable/reader.go?s=552:587#L14">NewReader</a></h3>
  143. <pre>func NewReader(r <a href="../../io/index.html">io</a>.<a href="../../io/index.html#Reader">Reader</a>) *<a href="index.html#Reader">Reader</a></pre>
  144. <p>
  145. NewReader returns a quoted-printable reader, decoding from r.
  146. </p>
  147. <h3 id="Reader.Read">func (*Reader) <a href="http://localhost:6060/src/mime/quotedprintable/reader.go?s=1504:1554#L62">Read</a></h3>
  148. <pre>func (r *<a href="index.html#Reader">Reader</a>) Read(p []<a href="../../builtin/index.html#byte">byte</a>) (n <a href="../../builtin/index.html#int">int</a>, err <a href="../../builtin/index.html#error">error</a>)</pre>
  149. <p>
  150. Read reads and decodes quoted-printable data from the underlying reader.
  151. </p>
  152. <h2 id="Writer">type <a href="http://localhost:6060/src/mime/quotedprintable/writer.go?s=294:491#L2">Writer</a></h2>
  153. <pre>type Writer struct {
  154. <span class="comment">// Binary mode treats the writer&#39;s input as pure binary and processes end of</span>
  155. <span class="comment">// line bytes as binary data.</span>
  156. Binary <a href="../../builtin/index.html#bool">bool</a>
  157. <span class="comment">// contains filtered or unexported fields</span>
  158. }</pre>
  159. <p>
  160. A Writer is a quoted-printable writer that implements io.WriteCloser.
  161. </p>
  162. <h3 id="NewWriter">func <a href="http://localhost:6060/src/mime/quotedprintable/writer.go?s=545:580#L14">NewWriter</a></h3>
  163. <pre>func NewWriter(w <a href="../../io/index.html">io</a>.<a href="../../io/index.html#Writer">Writer</a>) *<a href="index.html#Writer">Writer</a></pre>
  164. <p>
  165. NewWriter returns a new Writer that writes to w.
  166. </p>
  167. <h3 id="Writer.Close">func (*Writer) <a href="http://localhost:6060/src/mime/quotedprintable/writer.go?s=1499:1529#L57">Close</a></h3>
  168. <pre>func (w *<a href="index.html#Writer">Writer</a>) Close() <a href="../../builtin/index.html#error">error</a></pre>
  169. <p>
  170. Close closes the Writer, flushing any unwritten data to the underlying
  171. io.Writer, but does not close the underlying io.Writer.
  172. </p>
  173. <h3 id="Writer.Write">func (*Writer) <a href="http://localhost:6060/src/mime/quotedprintable/writer.go?s=822:873#L21">Write</a></h3>
  174. <pre>func (w *<a href="index.html#Writer">Writer</a>) Write(p []<a href="../../builtin/index.html#byte">byte</a>) (n <a href="../../builtin/index.html#int">int</a>, err <a href="../../builtin/index.html#error">error</a>)</pre>
  175. <p>
  176. Write encodes p using quoted-printable encoding and writes it to the
  177. underlying io.Writer. It limits line length to 76 characters. The encoded
  178. bytes are not necessarily flushed until the Writer is closed.
  179. </p>
  180. <div id="footer">
  181. Build version go1.6.<br>
  182. Except as <a href="https://developers.google.com/site-policies#restrictions">noted</a>,
  183. the content of this page is licensed under the
  184. Creative Commons Attribution 3.0 License,
  185. and code is licensed under a <a href="http://localhost:6060/LICENSE">BSD license</a>.<br>
  186. <a href="http://localhost:6060/doc/tos.html">Terms of Service</a> |
  187. <a href="http://www.google.com/intl/en/policies/privacy/">Privacy Policy</a>
  188. </div>
  189. </div><!-- .container -->
  190. </div><!-- #page -->
  191. <!-- TODO(adonovan): load these from <head> using "defer" attribute? -->
  192. <script type="text/javascript" src="../../../lib/godoc/jquery.js"></script>
  193. <script type="text/javascript" src="../../../lib/godoc/jquery.treeview.js"></script>
  194. <script type="text/javascript" src="../../../lib/godoc/jquery.treeview.edit.js"></script>
  195. <script type="text/javascript" src="../../../lib/godoc/godocs.js"></script>
  196. </body>
  197. </html>