import "os/user"

Overview

Index

type UnknownUserError

    func (e UnknownUserError) Error() string

type UnknownUserIdError

    func (e UnknownUserIdError) Error() string

type User

    func Current() (*User, error)

    func Lookup(username string) (*User, error)

    func LookupId(uid string) (*User, error)

Package files

lookup_unix.go user.go

type UnknownUserError

type UnknownUserError string

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

func (UnknownUserError) Error

func (e UnknownUserError) Error() string

type UnknownUserIdError

type UnknownUserIdError int

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

func (UnknownUserIdError) Error

func (e UnknownUserIdError) Error() string

type User

type User struct {
    Uid      string // user id
    Gid      string // primary group id
    Username string
    Name     string
    HomeDir  string
}

User represents a user account.

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.

func Current

func Current() (*User, error)

Current returns the current user.

func Lookup

func Lookup(username string) (*User, error)

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

func LookupId

func LookupId(uid string) (*User, error)

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