model

Documentation

Index

• Variables
• type FindOption
• type ID
• type Role
• type StringMD5
  • func EncodeStringMD5(str string) StringMD5
• type User
  • func (u *User) Copy(f *User)
• type UserDataAccessor
  • func (a *UserDataAccessor) FindAll() ([]User, error)
  • func (a *UserDataAccessor) FindByUserID(reqUserID string, option FindOption) ([]User, error)
  • func (a *UserDataAccessor) Start(echo *echo.Echo) error
  • func (a *UserDataAccessor) Stop()

Variables

var (
	ErrorNotFound        = errors.New("Not found")
	ErrorMultipleResults = errors.New("Multiple results")
	ErrorInvalidCommand  = errors.New("Invalid Command")
	ErrorBadParameter    = errors.New("Bad Parameter")
	ErrorNotImplemented  = errors.New("Not Implemented")
	ErrorOther           = errors.New("Other")
)

DataAccessorが返す各エラーのインスタンスを生成します。

Types

type FindOption

type FindOption int

FindOption は検索時のオプションを定義します。

const (
	FIndAll    FindOption = iota // 全件検索
	FindFirst                    // 1件目のみ返す
	FindUnique                   // 結果が1件のみでない場合にはエラーを返す
)

検索時のオプション

type ID

type ID string

ID は情報を一意に識別するためのIDです。

type Role

type Role string

Role はユーザーの権限を表します。

const (
	RoleAdmin Role = "admin"
	RoleUser  Role = "user"
)

ユーザー権限の定義

type StringMD5

type StringMD5 string

StringMD5 はMD5ハッシュ化された文字列です。

func EncodeStringMD5

func EncodeStringMD5(str string) StringMD5

EncodeStringMD5 は、MD5エンコードした文字列を返します。

type User

type User struct {
	ID       ID        `json:"id"`
	UserID   string    `json:"user_id"`
	Password StringMD5 `json:"password"`
	FullName string    `json:"full_name"`
	Roles    []Role    `json:"roles"`
}

User はユーザーの情報を表します。

func (*User) Copy

func (u *User) Copy(f *User)

Copy は情報のコピーを行います。

type UserDataAccessor

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

UserDataAccessor はユーザーの情報を操作するAPIを提供します。

func (*UserDataAccessor) FindAll

func (a *UserDataAccessor) FindAll() ([]User, error)

FindAll はユーザーを全件検索します。

func (*UserDataAccessor) FindByUserID

func (a *UserDataAccessor) FindByUserID(reqUserID string, option FindOption) ([]User, error)

FindByUserID はUserIDでユーザーを検索します。

func (*UserDataAccessor) Start

func (a *UserDataAccessor) Start(echo *echo.Echo) error

Start はAccessorの開始を行います。

func (*UserDataAccessor) Stop

func (a *UserDataAccessor) Stop()

Stop はAccessorの停止を行います。