Overview

Package user allows user account lookups by name or id.

Index

getgrouplist_unix.go lookup.go

Group represents a grouping of users.

On POSIX systems Gid contains a decimal number representing the group ID.

func LookupGroup

  1. func LookupGroup(name string) (*, error)

LookupGroup looks up a group by name. If the group cannot be found, the returned
error is of type UnknownGroupError.

func

  1. func LookupGroupId(gid ) (*Group, )

LookupGroupId looks up a group by groupid. If the group cannot be found, the
returned error is of type UnknownGroupIdError.

type UnknownGroupError

  1. type UnknownGroupError string

  1. func (e ) Error() string

type

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

func (UnknownGroupIdError)

  1. func (e ) Error() string

  1. type UnknownUserError

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

func (UnknownUserError) Error

  1. func (e UnknownUserError) Error()

type UnknownUserIdError

  1. type UnknownUserIdError int

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

type

  1. type User struct {
  2. // Uid is the user ID.
  3. // On POSIX systems, this is a decimal number representing the uid.
  4. // On Windows, this is a security identifier (SID) in a string format.
  5. // On Plan 9, this is the contents of /dev/user.
  6. Uid
  7. // Gid is the primary group ID.
  8. // On POSIX systems, this is a decimal number representing the gid.
  9. // On Plan 9, this is the contents of /dev/user.
  10. Gid string
  11. // Username is the login name.
  12. Username
  13. // Name is the user's real or display name.
  14. // It might be blank.
  15. // On POSIX systems, this is the first (or only) entry in the GECOS field
  16. // list.
  17. // On Windows, this is the user's display name.
  18. // On Plan 9, this is the contents of /dev/user.
  19. Name string
  20. // HomeDir is the path to the user's home directory (if they have one).
  21. HomeDir
  22. }

User represents a user account.

func Current

  1. func Current() (*User, )

Current returns the current user.

func Lookup

  1. func Lookup(username string) (*, error)

Lookup looks up a user by username. If the user cannot be found, the returned
error is of type UnknownUserError.

  1. func LookupId(uid ) (*User, )

LookupId looks up a user by userid. If the user cannot be found, the returned
error is of type UnknownUserIdError.

func (*User) GroupIds