Module: stdgo.os.user

(view library index)

Overview

Index

• class User

• function current():stdgo.Tuple<stdgo.os.user.User_, stdgo.Error>

• function lookup(_username:String):stdgo.Tuple<stdgo.os.user.User_, stdgo.Error>

• function lookupGroup(_name:String):stdgo.Tuple<stdgo.os.user.Group, stdgo.Error>

• function lookupGroupId(_gid:String):stdgo.Tuple<stdgo.os.user.Group, stdgo.Error>

• function lookupId(_uid:String):stdgo.Tuple<stdgo.os.user.User_, stdgo.Error>

• typedef T__struct_0

• typedef T_lineFunc

• typedef UnknownGroupError

• typedef UnknownGroupIdError

• typedef UnknownUserError

• typedef UnknownUserIdError

• abstract User_

• abstract Group

Classes

import

class User

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.

User function current

function current():stdgo.Tuple<stdgo.os.user.User_, stdgo.Error>

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.

(view code)

User function lookup

function lookup(_username:String):stdgo.Tuple<stdgo.os.user.User_, stdgo.Error>

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

(view code)

User function lookupGroup

function lookupGroup(_name:String):stdgo.Tuple<stdgo.os.user.Group, stdgo.Error>

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

(view code)

User function lookupGroupId

function lookupGroupId(_gid:String):stdgo.Tuple<stdgo.os.user.Group, stdgo.Error>

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

(view code)

User function lookupId

function lookupId(_uid:String):stdgo.Tuple<stdgo.os.user.User_, stdgo.Error>

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

(view code)

Typedefs

import

typedef T__struct_0

typedef T__struct_0 = stdgo._internal.os.user.T__struct_0;

typedef T_lineFunc

typedef T_lineFunc = stdgo._internal.os.user.T_lineFunc;

typedef UnknownGroupError

typedef UnknownGroupError = stdgo._internal.os.user.UnknownGroupError;

typedef UnknownGroupIdError

typedef UnknownGroupIdError = stdgo._internal.os.user.UnknownGroupIdError;

typedef UnknownUserError

typedef UnknownUserError = stdgo._internal.os.user.UnknownUserError;

typedef UnknownUserIdError

typedef UnknownUserIdError = stdgo._internal.os.user.UnknownUserIdError;

Abstracts

abstract User_

(view file containing code)

abstract Group

(view file containing code)