search

package

v0.4.0 Latest Latest Go to latest Published: Sep 8, 2021 License: MIT Imports: 6 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

This section is empty.

This section is empty.

This section is empty.

type UserIndex struct {
	// contains filtered or unexported fields
}

func NewUserIndex(db *database.Database, dataDir string) (*UserIndex, error)

NewUserIndex returns a new *UserIndex based upon the database and data directory given. Indexes will be stored at: {dataDir}/indexes/user

func (ui UserIndex) CompletionSuggestions(query string) ([]core.User, error)

CompletionSuggestions returns user suggestions starting with the query string or the query string with an ampersand in front.

func (ui UserIndex) Deindex(u core.User) error

Deindex deletes the index for a single user

func (ui UserIndex) EmailExists(email string) (bool, error)

EmailExists returns whether a user with an email exists, regardless of whether the existing user has verified that email.

func (ui UserIndex) FromEmail(email string) (core.User, error)

FromEmail returns the one verified user with this email or else a KeyNotFoundErr

func (ui UserIndex) Index(u core.User) error

Index will index a single user

func (ui UserIndex) Reindex() error

Reindex takes all users in the database and reindexes them.

func (ui UserIndex) VerifiedEmailExists(email string) (bool, error)

VerifiedEmailExists returns whether a user with an email exists if this existing user has also verified that email.

func (ui UserIndex) WithEmail(email string) ([]core.User, error)

WithEmail returns all users with this email regardless of whether they have verified the email.