user

package

v0.0.0-...-0cfb223 Latest Latest Go to latest Published: Jan 19, 2024 License: AGPL-3.0 Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/tarkov-database/rest-api

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func Create(user *User) error
func GetAll(opts *Options) (*model.Result, error)
func GetByEmail(addr string, opts *Options) (*model.Result, error)
func GetByLockedState(locked bool, opts *Options) (*model.Result, error)
func Remove(id string) error
func Replace(id string, user *User) error
type Options
type User
- func GetByID(id string) (*User, error)
- func (u *User) Validate() error

Constants ¶

View Source

const Collection = "users"

Collection indicates the MongoDB user collection

Variables ¶

View Source

var (
	// ErrInvalidEmail indicates that a email address is not valid
	ErrInvalidEmail = errors.New("invalid e-mail address")
)

Functions ¶

func Create ¶

func Create(user *User) error

Create creates a new entity

func GetAll ¶

func GetAll(opts *Options) (*model.Result, error)

GetAll returns a result based on filters

func GetByEmail ¶

func GetByEmail(addr string, opts *Options) (*model.Result, error)

GetByEmail returns a result based on email address

func GetByLockedState ¶

func GetByLockedState(locked bool, opts *Options) (*model.Result, error)

GetByLockedState returns a result based on lock state

func Remove ¶

func Remove(id string) error

Remove removes an entity

func Replace ¶

func Replace(id string, user *User) error

Replace replaces the data of an existing entity

Types ¶

type Options ¶

type Options struct {
	Sort   bson.D
	Limit  int64
	Offset int64
}

Options represents the options for a database operation

type User ¶

type User struct {
	ID       objectID  `json:"_id" bson:"_id"`
	Email    string    `json:"email" bson:"email"`
	Locked   bool      `json:"locked" bson:"locked"`
	Modified timestamp `json:"_modified" bson:"_modified"`
}

User describes the entity of a user

func GetByID ¶

func GetByID(id string) (*User, error)

GetByID returns the entity of the given ID

func (*User) Validate ¶

func (u *User) Validate() error

Validate validates the fields of a user

Source Files ¶

View all Source files

user.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL