go-neb/pkg/unicode/utf16/index.html

<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="theme-color" content="#375EAB">

  <title>utf16 - The Go Programming Language</title>

<link type="text/css" rel="stylesheet" href="../../../lib/godoc/style.css">

<link rel="stylesheet" href="../../../lib/godoc/jquery.treeview.css">
<script type="text/javascript">window.initFuncs = [];</script>
</head>
<body>

<div id='lowframe' style="position: fixed; bottom: 0; left: 0; height: 0; width: 100%; border-top: thin solid grey; background-color: white; overflow: auto;">
...
</div><!-- #lowframe -->

<div id="topbar" class="wide"><div class="container">
<div class="top-heading" id="heading-wide"><a href="http://localhost:6060/">The Go Programming Language</a></div>
<div class="top-heading" id="heading-narrow"><a href="http://localhost:6060/">Go</a></div>
<a href="index.html#" id="menu-button"><span id="menu-button-arrow">&#9661;</span></a>
<form method="GET" action="http://localhost:6060/search">
<div id="menu">
<a href="http://localhost:6060/doc/">Documents</a>
<a href="http://localhost:6060/pkg/">Packages</a>
<a href="http://localhost:6060/project/">The Project</a>
<a href="http://localhost:6060/help/">Help</a>
<a href="http://localhost:6060/blog/">Blog</a>

<input type="text" id="search" name="q" class="inactive" value="Search" placeholder="Search">
</div>
</form>

</div></div>


<div id="page" class="wide">
<div class="container">


  <h1>Package utf16</h1>


<div id="nav"></div>


<!--
	Copyright 2009 The Go Authors. All rights reserved.
	Use of this source code is governed by a BSD-style
	license that can be found in the LICENSE file.
-->
<!--
	Note: Static (i.e., not template-generated) href and id
	attributes start with "pkg-" to make it impossible for
	them to conflict with generated attributes (some of which
	correspond to Go identifiers).
-->

	<script type='text/javascript'>
	document.ANALYSIS_DATA = null;
	document.CALLGRAPH = null;
	</script>

	
		<div id="short-nav">
			<dl>
			<dd><code>import "unicode/utf16"</code></dd>
			</dl>
			<dl>
			<dd><a href="index.html#pkg-overview" class="overviewLink">Overview</a></dd>
			<dd><a href="index.html#pkg-index" class="indexLink">Index</a></dd>
			
			
			</dl>
		</div>
		<!-- The package's Name is printed as title by the top-level template -->
		<div id="pkg-overview" class="toggleVisible">
			<div class="collapsed">
				<h2 class="toggleButton" title="Click to show Overview section">Overview ▹</h2>
			</div>
			<div class="expanded">
				<h2 class="toggleButton" title="Click to hide Overview section">Overview ▾</h2>
				<p>
Package utf16 implements encoding and decoding of UTF-16 sequences.
</p>

			</div>
		</div>
		

		<div id="pkg-index" class="toggleVisible">
		<div class="collapsed">
			<h2 class="toggleButton" title="Click to show Index section">Index ▹</h2>
		</div>
		<div class="expanded">
			<h2 class="toggleButton" title="Click to hide Index section">Index ▾</h2>

		<!-- Table of contents for API; must be named manual-nav to turn off auto nav. -->
			<div id="manual-nav">
			<dl>
			
			
				<dd><a href="index.html#Decode">func Decode(s []uint16) []rune</a></dd>
			
				
				<dd><a href="index.html#DecodeRune">func DecodeRune(r1, r2 rune) rune</a></dd>
			
				
				<dd><a href="index.html#Encode">func Encode(s []rune) []uint16</a></dd>
			
				
				<dd><a href="index.html#EncodeRune">func EncodeRune(r rune) (r1, r2 rune)</a></dd>
			
				
				<dd><a href="index.html#IsSurrogate">func IsSurrogate(r rune) bool</a></dd>
			
			
			</dl>
			</div><!-- #manual-nav -->

		
			<h4>Package files</h4>
			<p>
			<span style="font-size:90%">
			
				<a href="http://localhost:6060/src/unicode/utf16/utf16.go">utf16.go</a>
			
			</span>
			</p>
		
		</div><!-- .expanded -->
		</div><!-- #pkg-index -->

		<div id="pkg-callgraph" class="toggle" style="display: none">
		<div class="collapsed">
			<h2 class="toggleButton" title="Click to show Internal Call Graph section">Internal call graph ▹</h2>
		</div> <!-- .expanded -->
		<div class="expanded">
			<h2 class="toggleButton" title="Click to hide Internal Call Graph section">Internal call graph ▾</h2>
			<p>
			  In the call graph viewer below, each node
			  is a function belonging to this package
			  and its children are the functions it
			  calls&mdash;perhaps dynamically.
			</p>
			<p>
			  The root nodes are the entry points of the
			  package: functions that may be called from
			  outside the package.
			  There may be non-exported or anonymous
			  functions among them if they are called
			  dynamically from another package.
			</p>
			<p>
			  Click a node to visit that function's source code.
			  From there you can visit its callers by
			  clicking its declaring <code>func</code>
			  token.
			</p>
			<p>
			  Functions may be omitted if they were
			  determined to be unreachable in the
			  particular programs or tests that were
			  analyzed.
			</p>
			<!-- Zero means show all package entry points. -->
			<ul style="margin-left: 0.5in" id="callgraph-0" class="treeview"></ul>
		</div>
		</div> <!-- #pkg-callgraph -->

		
			<h2 id="Decode">func <a href="http://localhost:6060/src/unicode/utf16/utf16.go?s=2324:2354#L76">Decode</a></h2>
			<pre>func Decode(s []<a href="../../builtin/index.html#uint16">uint16</a>) []<a href="../../builtin/index.html#rune">rune</a></pre>
			<p>
Decode returns the Unicode code point sequence represented
by the UTF-16 encoding s.
</p>

			
			<h2 id="DecodeRune">func <a href="http://localhost:6060/src/unicode/utf16/utf16.go?s=1165:1198#L27">DecodeRune</a></h2>
			<pre>func DecodeRune(r1, r2 <a href="../../builtin/index.html#rune">rune</a>) <a href="../../builtin/index.html#rune">rune</a></pre>
			<p>
DecodeRune returns the UTF-16 decoding of a surrogate pair.
If the pair is not a valid UTF-16 surrogate pair, DecodeRune returns
the Unicode replacement code point U+FFFD.
</p>

			
			<h2 id="Encode">func <a href="http://localhost:6060/src/unicode/utf16/utf16.go?s=1808:1838#L46">Encode</a></h2>
			<pre>func Encode(s []<a href="../../builtin/index.html#rune">rune</a>) []<a href="../../builtin/index.html#uint16">uint16</a></pre>
			<p>
Encode returns the UTF-16 encoding of the Unicode code point sequence s.
</p>

			
			<h2 id="EncodeRune">func <a href="http://localhost:6060/src/unicode/utf16/utf16.go?s=1530:1567#L37">EncodeRune</a></h2>
			<pre>func EncodeRune(r <a href="../../builtin/index.html#rune">rune</a>) (r1, r2 <a href="../../builtin/index.html#rune">rune</a>)</pre>
			<p>
EncodeRune returns the UTF-16 surrogate pair r1, r2 for the given rune.
If the rune is not a valid Unicode code point or does not need encoding,
EncodeRune returns U+FFFD, U+FFFD.
</p>

			
			<h2 id="IsSurrogate">func <a href="http://localhost:6060/src/unicode/utf16/utf16.go?s=917:946#L20">IsSurrogate</a></h2>
			<pre>func IsSurrogate(r <a href="../../builtin/index.html#rune">rune</a>) <a href="../../builtin/index.html#bool">bool</a></pre>
			<p>
IsSurrogate reports whether the specified Unicode code point
can appear in a surrogate pair.
</p>

			
<div id="footer">
Build version go1.6.<br>
Except as <a href="https://developers.google.com/site-policies#restrictions">noted</a>,
the content of this page is licensed under the
Creative Commons Attribution 3.0 License,
and code is licensed under a <a href="http://localhost:6060/LICENSE">BSD license</a>.<br>
<a href="http://localhost:6060/doc/tos.html">Terms of Service</a> | 
<a href="http://www.google.com/intl/en/policies/privacy/">Privacy Policy</a>
</div>

</div><!-- .container -->
</div><!-- #page -->

<!-- TODO(adonovan): load these from <head> using "defer" attribute? -->
<script type="text/javascript" src="../../../lib/godoc/jquery.js"></script>
<script type="text/javascript" src="../../../lib/godoc/jquery.treeview.js"></script>
<script type="text/javascript" src="../../../lib/godoc/jquery.treeview.edit.js"></script>


<script type="text/javascript" src="../../../lib/godoc/godocs.js"></script>

</body>
</html>