<!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>user - 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">▽</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 user</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 "os/user"</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 user allows user account lookups by name or id.
</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#UnknownUserError">type UnknownUserError</a></dd>
<dd> <a href="index.html#UnknownUserError.Error">func (e UnknownUserError) Error() string</a></dd>
<dd><a href="index.html#UnknownUserIdError">type UnknownUserIdError</a></dd>
<dd> <a href="index.html#UnknownUserIdError.Error">func (e UnknownUserIdError) Error() string</a></dd>
<dd><a href="index.html#User">type User</a></dd>
<dd> <a href="index.html#Current">func Current() (*User, error)</a></dd>
<dd> <a href="index.html#Lookup">func Lookup(username string) (*User, error)</a></dd>
<dd> <a href="index.html#LookupId">func LookupId(uid string) (*User, error)</a></dd>
</dl>
</div><!-- #manual-nav -->
<h4>Package files</h4>
<p>
<span style="font-size:90%">
<a href="http://localhost:6060/src/os/user/lookup.go">lookup.go</a>
<a href="http://localhost:6060/src/os/user/lookup_unix.go">lookup_unix.go</a>
<a href="http://localhost:6060/src/os/user/user.go">user.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—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="UnknownUserError">type <a href="http://localhost:6060/src/os/user/user.go?s=1029:1057#L29">UnknownUserError</a></h2>
<pre>type UnknownUserError <a href="../../builtin/index.html#string">string</a></pre>
<p>
UnknownUserError is returned by Lookup when
a user cannot be found.
</p>
<h3 id="UnknownUserError.Error">func (UnknownUserError) <a href="http://localhost:6060/src/os/user/user.go?s=1059:1099#L31">Error</a></h3>
<pre>func (e <a href="index.html#UnknownUserError">UnknownUserError</a>) Error() <a href="../../builtin/index.html#string">string</a></pre>
<h2 id="UnknownUserIdError">type <a href="http://localhost:6060/src/os/user/user.go?s=823:850#L21">UnknownUserIdError</a></h2>
<pre>type UnknownUserIdError <a href="../../builtin/index.html#int">int</a></pre>
<p>
UnknownUserIdError is returned by LookupId when
a user cannot be found.
</p>
<h3 id="UnknownUserIdError.Error">func (UnknownUserIdError) <a href="http://localhost:6060/src/os/user/user.go?s=852:894#L23">Error</a></h3>
<pre>func (e <a href="index.html#UnknownUserIdError">UnknownUserIdError</a>) Error() <a href="../../builtin/index.html#string">string</a></pre>
<h2 id="User">type <a href="http://localhost:6060/src/os/user/user.go?s=607:743#L11">User</a></h2>
<pre>type User struct {
Uid <a href="../../builtin/index.html#string">string</a> <span class="comment">// user id</span>
Gid <a href="../../builtin/index.html#string">string</a> <span class="comment">// primary group id</span>
Username <a href="../../builtin/index.html#string">string</a>
Name <a href="../../builtin/index.html#string">string</a>
HomeDir <a href="../../builtin/index.html#string">string</a>
}</pre>
<p>
User represents a user account.
</p>
<p>
On posix systems Uid and Gid contain a decimal number
representing uid and gid. On windows Uid and Gid
contain security identifier (SID) in a string format.
On Plan 9, Uid, Gid, Username, and Name will be the
contents of /dev/user.
</p>
<h3 id="Current">func <a href="http://localhost:6060/src/os/user/lookup.go?s=211:240#L1">Current</a></h3>
<pre>func Current() (*<a href="index.html#User">User</a>, <a href="../../builtin/index.html#error">error</a>)</pre>
<p>
Current returns the current user.
</p>
<h3 id="Lookup">func <a href="http://localhost:6060/src/os/user/lookup.go?s=383:426#L4">Lookup</a></h3>
<pre>func Lookup(username <a href="../../builtin/index.html#string">string</a>) (*<a href="index.html#User">User</a>, <a href="../../builtin/index.html#error">error</a>)</pre>
<p>
Lookup looks up a user by username. If the user cannot be found, the
returned error is of type UnknownUserError.
</p>
<h3 id="LookupId">func <a href="http://localhost:6060/src/os/user/lookup.go?s=578:618#L10">LookupId</a></h3>
<pre>func LookupId(uid <a href="../../builtin/index.html#string">string</a>) (*<a href="index.html#User">User</a>, <a href="../../builtin/index.html#error">error</a>)</pre>
<p>
LookupId looks up a user by userid. If the user cannot be found, the
returned error is of type UnknownUserIdError.
</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>