users

Documentation

Index

• type Email
  • func ParseEmail(email string) (Email, error)
• type Error
  • func (e Error) Error() string

Types

type Email

type Email string

Email represents an email address on the form: "name@domain"

func ParseEmail

func ParseEmail(email string) (Email, error)

ParseEmail will parse the email address, returning the valid email address with trimmed spaces on success or a non-nil error in case of failure.

type Error

type Error string

Error represents errors related to users They should always be checked using errors.Is since the error may be wrapped with more context.

const (
	InvalidUserParamErr  Error = "user has invalid param"
	UserAlreadyExistsErr Error = "user already exists"
)

func (Error) Error

func (e Error) Error() string

Error returns the string representation of the error