user

Documentation

Overview

Package user handles a user database.

Index

• Constants
• func AuthenticateUser(db database.DB, user User, password string) error
• func CreateTable(db database.DB) error
• func DeleteUserByID(db database.DB, id int64) error
• func SetUserPassword(db database.DB, user User, password string) error
• func UpdateUser(db database.DB, user User) error
• type User
  • func All(db database.DB) ([]User, error)
  • func FindByEmail(db database.DB, email string) (User, bool, error)
  • func FindByID(db database.DB, id int64) (User, bool, error)
  • func New(db database.DB, user User) (User, error)
  • func (u User) String() string

Constants

const (
	// HashLength defines the lenght of the password hash.
	HashLength = 64
	// SaltLength defines the length of the salt.
	SaltLength = 32
)

const Name = "users"

Name of the table

Functions

func AuthenticateUser

func AuthenticateUser(db database.DB, user User, password string) error

func CreateTable

func CreateTable(db database.DB) error

CreateTable creates the users table.

func DeleteUserByID

func DeleteUserByID(db database.DB, id int64) error

func SetUserPassword

func SetUserPassword(db database.DB, user User, password string) error

func UpdateUser

func UpdateUser(db database.DB, user User) error

Types

type User

type User struct {
	Name      string `json:"name"`
	Email     string `json:"email"`
	Institute string `json:"institute"`
	ID        int64  `json:"id"`
	Admin     bool   `json:"admin"`
}

func All

func All(db database.DB) ([]User, error)

All returns all users in the database.

func FindByEmail

func FindByEmail(db database.DB, email string) (User, bool, error)

func FindByID

func FindByID(db database.DB, id int64) (User, bool, error)

func New

func New(db database.DB, user User) (User, error)

func (User) String

func (u User) String() string