Namespace: go.std.os.user

v1.0

Contents

• Summary
• Index
• Constants
• Variables
• Functions, Macros, and Special Forms
• Types

Summary

Provides a low-level interface to the os/user package.

Package user allows user account lookups by name or id.

For most Unix systems, this package has two internal implementations of
resolving user and group ids to names, and listing supplementary group IDs.
One is written in pure Go and parses /etc/passwd and /etc/group. The other
is cgo-based and relies on the standard C library (libc) routines such as
getpwuid_r, getgrnam_r, and getgrouplist.

When cgo is available, and the required routines are implemented in libc
for a particular platform, cgo-based (libc-backed) code is used.
This can be overridden by using osusergo build tag, which enforces
the pure Go implementation.

Index

• *Group
• *UnknownGroupError
• *UnknownGroupIdError
• *UnknownUserError
• *UnknownUserIdError
• *User
• Current
• Group
• Lookup
• LookupGroup
• LookupGroupId
• LookupId
• UnknownGroupError
• UnknownGroupIdError
• UnknownUserError
• UnknownUserIdError
• User
• arrayOfGroup
• arrayOfUnknownGroupError
• arrayOfUnknownGroupIdError
• arrayOfUnknownUserError
• arrayOfUnknownUserIdError
• arrayOfUser

Legend

Constant Variable Function Macro Special form Type GoVar Receiver/Method

Constants

Constants are variables with :const true in their metadata. Joker currently does not recognize them as special; as such, it allows redefining them or their values.

(None.)

Variables

(None.)

Functions, Macros, and Special Forms

• Current

  Function v1.0

  (Current)
  

  Current returns the current user.
  
  The first call will cache the current user information.
  Subsequent calls will return the cached value and will not reflect
  changes to the current user.
  
  Go returns: (*User, error)
  
  Joker input arguments: []
  
  Joker returns: [^*User, ^Error]

• Lookup

  Function v1.0

  (Lookup username)
  

  Lookup looks up a user by username. If the user cannot be found, the
  returned error is of type UnknownUserError.
  
  Go input arguments: (username string)
  
  Go returns: (*User, error)
  
  Joker input arguments: [^String username]
  
  Joker returns: [^*User, ^Error]

• LookupGroup

  Function v1.0

  (LookupGroup name)
  

  LookupGroup looks up a group by name. If the group cannot be found, the
  returned error is of type UnknownGroupError.
  
  Go input arguments: (name string)
  
  Go returns: (*Group, error)
  
  Joker input arguments: [^String name]
  
  Joker returns: [^*Group, ^Error]

• LookupGroupId

  Function v1.0

  (LookupGroupId gid)
  

  LookupGroupId looks up a group by groupid. If the group cannot be found, the
  returned error is of type UnknownGroupIdError.
  
  Go input arguments: (gid string)
  
  Go returns: (*Group, error)
  
  Joker input arguments: [^String gid]
  
  Joker returns: [^*Group, ^Error]

• LookupId

  Function v1.0

  (LookupId uid)
  

  LookupId looks up a user by userid. If the user cannot be found, the
  returned error is of type UnknownUserIdError.
  
  Go input arguments: (uid string)
  
  Go returns: (*User, error)
  
  Joker input arguments: [^String uid]
  
  Joker returns: [^*User, ^Error]

Types

• *Group

  Concrete Type v1.0

  Group represents a grouping of users.
  
  On POSIX systems Gid contains a decimal number representing the group ID.
  

• *UnknownGroupError

  Concrete Type v1.0

  UnknownGroupError is returned by LookupGroup when
  a group cannot be found.
  

• *UnknownGroupIdError

  Concrete Type v1.0

  UnknownGroupIdError is returned by LookupGroupId when
  a group cannot be found.
  

• *UnknownUserError

  Concrete Type v1.0

  UnknownUserError is returned by Lookup when
  a user cannot be found.
  

• *UnknownUserIdError

  Concrete Type v1.0

  UnknownUserIdError is returned by LookupId when a user cannot be found.
  

• *User

  Concrete Type v1.0

  User represents a user account.
  

• GroupIds

  Receiver for *User v1.0

  ([])
  

  GroupIds returns the list of group IDs that the user is a member of.
  

• Group

  Concrete Type v1.0

  Group represents a grouping of users.
  
  On POSIX systems Gid contains a decimal number representing the group ID.
  

• UnknownGroupError

  Concrete Type v1.0

  UnknownGroupError is returned by LookupGroup when
  a group cannot be found.
  

• Error

  Receiver for UnknownGroupError v1.0

  ([])
  

• UnknownGroupIdError

  Concrete Type v1.0

  UnknownGroupIdError is returned by LookupGroupId when
  a group cannot be found.
  

• Error

  Receiver for UnknownGroupIdError v1.0

  ([])
  

• UnknownUserError

  Concrete Type v1.0

  UnknownUserError is returned by Lookup when
  a user cannot be found.
  

• Error

  Receiver for UnknownUserError v1.0

  ([])
  

• UnknownUserIdError

  Concrete Type v1.0

  UnknownUserIdError is returned by LookupId when a user cannot be found.
  

• Error

  Receiver for UnknownUserIdError v1.0

  ([])
  

• User

  Concrete Type v1.0

  User represents a user account.
  

• arrayOfGroup

  Concrete Type v1.0

  Group represents a grouping of users.
  
  On POSIX systems Gid contains a decimal number representing the group ID.
  

• arrayOfUnknownGroupError

  Concrete Type v1.0

  UnknownGroupError is returned by LookupGroup when
  a group cannot be found.
  

• arrayOfUnknownGroupIdError

  Concrete Type v1.0

  UnknownGroupIdError is returned by LookupGroupId when
  a group cannot be found.
  

• arrayOfUnknownUserError

  Concrete Type v1.0

  UnknownUserError is returned by Lookup when
  a user cannot be found.
  

• arrayOfUnknownUserIdError

  Concrete Type v1.0

  UnknownUserIdError is returned by LookupId when a user cannot be found.
  

• arrayOfUser

  Concrete Type v1.0

  User represents a user account.