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.

281 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>charset - 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 charset</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 "golang.org/x/net/html/charset"</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 charset provides common text encodings for HTML documents.
  68. </p>
  69. <p>
  70. The mapping from encoding labels to encodings is defined at
  71. <a href="https://encoding.spec.whatwg.org/">https://encoding.spec.whatwg.org/</a>.
  72. </p>
  73. </div>
  74. </div>
  75. <div id="pkg-index" class="toggleVisible">
  76. <div class="collapsed">
  77. <h2 class="toggleButton" title="Click to show Index section">Index ▹</h2>
  78. </div>
  79. <div class="expanded">
  80. <h2 class="toggleButton" title="Click to hide Index section">Index ▾</h2>
  81. <!-- Table of contents for API; must be named manual-nav to turn off auto nav. -->
  82. <div id="manual-nav">
  83. <dl>
  84. <dd><a href="index.html#DetermineEncoding">func DetermineEncoding(content []byte, contentType string) (e encoding.Encoding, name string, certain bool)</a></dd>
  85. <dd><a href="index.html#Lookup">func Lookup(label string) (e encoding.Encoding, name string)</a></dd>
  86. <dd><a href="index.html#NewReader">func NewReader(r io.Reader, contentType string) (io.Reader, error)</a></dd>
  87. <dd><a href="index.html#NewReaderLabel">func NewReaderLabel(label string, input io.Reader) (io.Reader, 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/golang.org/x/net/html/charset/charset.go">charset.go</a>
  94. </span>
  95. </p>
  96. </div><!-- .expanded -->
  97. </div><!-- #pkg-index -->
  98. <div id="pkg-callgraph" class="toggle" style="display: none">
  99. <div class="collapsed">
  100. <h2 class="toggleButton" title="Click to show Internal Call Graph section">Internal call graph ▹</h2>
  101. </div> <!-- .expanded -->
  102. <div class="expanded">
  103. <h2 class="toggleButton" title="Click to hide Internal Call Graph section">Internal call graph ▾</h2>
  104. <p>
  105. In the call graph viewer below, each node
  106. is a function belonging to this package
  107. and its children are the functions it
  108. calls&mdash;perhaps dynamically.
  109. </p>
  110. <p>
  111. The root nodes are the entry points of the
  112. package: functions that may be called from
  113. outside the package.
  114. There may be non-exported or anonymous
  115. functions among them if they are called
  116. dynamically from another package.
  117. </p>
  118. <p>
  119. Click a node to visit that function's source code.
  120. From there you can visit its callers by
  121. clicking its declaring <code>func</code>
  122. token.
  123. </p>
  124. <p>
  125. Functions may be omitted if they were
  126. determined to be unreachable in the
  127. particular programs or tests that were
  128. analyzed.
  129. </p>
  130. <!-- Zero means show all package entry points. -->
  131. <ul style="margin-left: 0.5in" id="callgraph-0" class="treeview"></ul>
  132. </div>
  133. </div> <!-- #pkg-callgraph -->
  134. <h2 id="DetermineEncoding">func <a href="http://localhost:6060/src/golang.org/x/net/html/charset/charset.go?s=1729:1836#L42">DetermineEncoding</a></h2>
  135. <pre>func DetermineEncoding(content []<a href="../../../../../builtin/index.html#byte">byte</a>, contentType <a href="../../../../../builtin/index.html#string">string</a>) (e <a href="../../../text/encoding/index.html">encoding</a>.<a href="../../../text/encoding/index.html#Encoding">Encoding</a>, name <a href="../../../../../builtin/index.html#string">string</a>, certain <a href="../../../../../builtin/index.html#bool">bool</a>)</pre>
  136. <p>
  137. DetermineEncoding determines the encoding of an HTML document by examining
  138. up to the first 1024 bytes of content and the declared Content-Type.
  139. </p>
  140. <p>
  141. See <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/parsing.html#determining-the-character-encoding">http://www.whatwg.org/specs/web-apps/current-work/multipage/parsing.html#determining-the-character-encoding</a>
  142. </p>
  143. <h2 id="Lookup">func <a href="http://localhost:6060/src/golang.org/x/net/html/charset/charset.go?s=981:1041#L21">Lookup</a></h2>
  144. <pre>func Lookup(label <a href="../../../../../builtin/index.html#string">string</a>) (e <a href="../../../text/encoding/index.html">encoding</a>.<a href="../../../text/encoding/index.html#Encoding">Encoding</a>, name <a href="../../../../../builtin/index.html#string">string</a>)</pre>
  145. <p>
  146. Lookup returns the encoding with the specified label, and its canonical
  147. name. It returns nil and the empty string if label is not one of the
  148. standard encodings for HTML. Matching is case-insensitive and ignores
  149. leading and trailing whitespace. Encoders will use HTML escape sequences for
  150. runes that are not supported by the character set.
  151. </p>
  152. <h2 id="NewReader">func <a href="http://localhost:6060/src/golang.org/x/net/html/charset/charset.go?s=2989:3055#L98">NewReader</a></h2>
  153. <pre>func NewReader(r <a href="../../../../../io/index.html">io</a>.<a href="../../../../../io/index.html#Reader">Reader</a>, contentType <a href="../../../../../builtin/index.html#string">string</a>) (<a href="../../../../../io/index.html">io</a>.<a href="../../../../../io/index.html#Reader">Reader</a>, <a href="../../../../../builtin/index.html#error">error</a>)</pre>
  154. <p>
  155. NewReader returns an io.Reader that converts the content of r to UTF-8.
  156. It calls DetermineEncoding to find out what r&#39;s encoding is.
  157. </p>
  158. <h2 id="NewReaderLabel">func <a href="http://localhost:6060/src/golang.org/x/net/html/charset/charset.go?s=3740:3809#L121">NewReaderLabel</a></h2>
  159. <pre>func NewReaderLabel(label <a href="../../../../../builtin/index.html#string">string</a>, input <a href="../../../../../io/index.html">io</a>.<a href="../../../../../io/index.html#Reader">Reader</a>) (<a href="../../../../../io/index.html">io</a>.<a href="../../../../../io/index.html#Reader">Reader</a>, <a href="../../../../../builtin/index.html#error">error</a>)</pre>
  160. <p>
  161. NewReaderLabel returns a reader that converts from the specified charset to
  162. UTF-8. It uses Lookup to find the encoding that corresponds to label, and
  163. returns an error if Lookup returns nil. It is suitable for use as
  164. encoding/xml.Decoder&#39;s CharsetReader function.
  165. </p>
  166. <div id="footer">
  167. Build version go1.6.<br>
  168. Except as <a href="https://developers.google.com/site-policies#restrictions">noted</a>,
  169. the content of this page is licensed under the
  170. Creative Commons Attribution 3.0 License,
  171. and code is licensed under a <a href="http://localhost:6060/LICENSE">BSD license</a>.<br>
  172. <a href="http://localhost:6060/doc/tos.html">Terms of Service</a> |
  173. <a href="http://www.google.com/intl/en/policies/privacy/">Privacy Policy</a>
  174. </div>
  175. </div><!-- .container -->
  176. </div><!-- #page -->
  177. <!-- TODO(adonovan): load these from <head> using "defer" attribute? -->
  178. <script type="text/javascript" src="../../../../../../lib/godoc/jquery.js"></script>
  179. <script type="text/javascript" src="../../../../../../lib/godoc/jquery.treeview.js"></script>
  180. <script type="text/javascript" src="../../../../../../lib/godoc/jquery.treeview.edit.js"></script>
  181. <script type="text/javascript" src="../../../../../../lib/godoc/godocs.js"></script>
  182. </body>
  183. </html>