package user

Import Path
	os/user (on go.dev)

Dependency Relation
	imports 10 packages, and imported by one package


Involved Source Files

	    listgroups_unix.go
	    lookup.go
	    lookup_stubs.go
	    lookup_unix.go
	
		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.


Package-Level Type Names (total 6)


	/* sort by:  |  */
	
		Group represents a grouping of users.
		
		On POSIX systems Gid contains a decimal number representing the group ID.

		
			
				// group ID

			
				// group name

		
			func LookupGroup(name string) (*Group, error)
			func LookupGroupId(gid string) (*Group, error)


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

		
			( UnknownGroupError) Error() string
		
			 UnknownGroupError : error


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

		
			( UnknownGroupIdError) Error() string
		
			 UnknownGroupIdError : error


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

		
			( UnknownUserError) Error() string
		
			 UnknownUserError : error


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

		
			( UnknownUserIdError) Error() string
		
			 UnknownUserIdError : error


	
		User represents a user account.

		
			
				Gid is the primary group ID.
				On POSIX systems, this is a decimal number representing the gid.
				On Windows, this is a SID in a string format.
				On Plan 9, this is the contents of /dev/user.

			
				HomeDir is the path to the user's home directory (if they have one).

			
				Name is the user's real or display name.
				It might be blank.
				On POSIX systems, this is the first (or only) entry in the GECOS field
				list.
				On Windows, this is the user's display name.
				On Plan 9, this is the contents of /dev/user.

			
				Uid is the user ID.
				On POSIX systems, this is a decimal number representing the uid.
				On Windows, this is a security identifier (SID) in a string format.
				On Plan 9, this is the contents of /dev/user.

			
				Username is the login name.

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

		
			func Current() (*User, error)
			func Lookup(username string) (*User, error)
			func LookupId(uid string) (*User, error)




Package-Level Functions (total 5)


	
		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.


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


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


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


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