Documentation
¶
Overview ¶
Package usr has the User type and associated methods to create, modify and delete application users
Index ¶
- Variables
- type User
- func (u *User) Create(ctx context.Context, log zerolog.Logger) error
- func (u *User) CreateDB(ctx context.Context, log zerolog.Logger, tx *sql.Tx) error
- func (u *User) Email() string
- func (u *User) FirstName() string
- func (u *User) LastName() string
- func (u *User) MobileID() string
- func (u *User) Password() string
- func (u *User) SetEmail(email string) error
- func (u *User) SetFirstName(firstName string) error
- func (u *User) SetLastName(lastName string) error
- func (u *User) SetMobileID(mobileID string) error
- func (u *User) SetPassword(ctx context.Context, password string) error
- func (u *User) SetUpdateClientID(clientID string) error
- func (u *User) SetUpdateTimestamp(updateTimestamp time.Time) error
- func (u *User) SetUpdateUserID(userID string) error
- func (u *User) SetUsername(username string) error
- func (u *User) UpdateClientID() string
- func (u *User) UpdateTimestamp() time.Time
- func (u *User) UpdateUserID() string
- func (u *User) Username() string
Examples ¶
Constants ¶
This section is empty.
Variables ¶
var ErrNoUser = errors.Str("User does not exist")
ErrNoUser is an error when a user is passed that does not exist in the db
Functions ¶
This section is empty.
Types ¶
type User ¶
type User struct {
// contains filtered or unexported fields
}
User represents an application user. A user can access multiple systems. The User-Application relationship is kept elsewhere...
Example ¶
package main
import (
"fmt"
"github.com/gilcrest/go-API-template/appuser"
)
func main() {
usr := new(appuser.User)
usr.SetUsername("repoMan")
usr.SetMobileID("(617) 302-7777")
usr.SetEmail("repoman@alwaysintense.com")
usr.SetFirstName("Otto")
usr.SetLastName("Maddox")
fmt.Println(usr.Username())
fmt.Println(usr.MobileID())
fmt.Println(usr.Email())
fmt.Println(usr.FirstName())
fmt.Println(usr.LastName())
}
Output: repoMan (617) 302-7777 repoman@alwaysintense.com Otto Maddox
func UserFromUsername ¶
func UserFromUsername(ctx context.Context, log zerolog.Logger, tx *sql.Tx, username string) (*User, error)
UserFromUsername constructs a User given a username
func (*User) SetFirstName ¶
SetFirstName is a setter for User.firstName
func (*User) SetLastName ¶
SetLastName is a setter for User.lastName
func (*User) SetMobileID ¶
SetMobileID is a setter for User.username
func (*User) SetPassword ¶
SetPassword is a setter for password
func (*User) SetUpdateClientID ¶
SetUpdateClientID is a setter for User.updateClientID
func (*User) SetUpdateTimestamp ¶
SetUpdateTimestamp is a setter for User.updateTimestamp
func (*User) SetUpdateUserID ¶
SetUpdateUserID is a setter for User.UpdateUserID
func (*User) SetUsername ¶
SetUsername is a setter for User.username
func (*User) UpdateClientID ¶
UpdateClientID is a getter for User.updateClientID
func (*User) UpdateTimestamp ¶
UpdateTimestamp is a getter for User.updateDate
func (*User) UpdateUserID ¶
UpdateUserID is a getter for User.updateUserID
Source Files