user

Documentation

Index

• type Fields
• type FriendItem
• type FullUser
• type GroupID
• type PrivacySettings
  • func (settings *PrivacySettings) Unmarshal(s []byte)
• type PrivacySettingsField
• type ReceiveFilter
• type Repo
  • func NewMysqlRepo(q *query.Query, log *zap.Logger) (Repo, error)
• type User
  • func (u User) GetID() model.UserID

Types

type Fields

type Fields struct {
	Site      string
	Location  string
	Bio       string
	BlockList []model.UserID
	Privacy   PrivacySettings
	UID       model.UserID
}

type FriendItem

type FriendItem struct{}

type FullUser

type FullUser struct {
	RegistrationTime time.Time
	NickName         string
	Avatar           string
	Sign             string
	UserName         string
	ID               model.UserID
	UserGroup        GroupID
	TimeOffset       int8
}

FullUser is for current user or admin only.

type GroupID

type GroupID = uint8

type PrivacySettings

type PrivacySettings struct {
	ReceivePrivateMessage      ReceiveFilter
	ReceiveTimelineReply       ReceiveFilter
	ReceiveMentionNotification ReceiveFilter
	ReceiveCommentNotification ReceiveFilter
}

func (*PrivacySettings) Unmarshal

func (settings *PrivacySettings) Unmarshal(s []byte)

type PrivacySettingsField

type PrivacySettingsField int

const (
	PrivacyReceivePrivateMessage      PrivacySettingsField = 1
	PrivacyReceiveTimelineReply       PrivacySettingsField = 30
	PrivacyReceiveMentionNotification PrivacySettingsField = 20
	PrivacyReceiveCommentNotification PrivacySettingsField = 21
)

type ReceiveFilter

type ReceiveFilter uint8

const (
	ReceiveFilterAll ReceiveFilter = iota
	ReceiveFilterFriends
	ReceiveFilterNone
)

type Repo

type Repo interface {
	// GetFullUser find a user by uid.
	GetFullUser(ctx context.Context, userID model.UserID) (FullUser, error)

	// GetByID find a user by uid.
	GetByID(ctx context.Context, userID model.UserID) (User, error)
	// GetByName find a user by username.
	GetByName(ctx context.Context, username string) (User, error)

	GetByIDs(ctx context.Context, ids []model.UserID) (map[model.UserID]User, error)

	GetFriends(ctx context.Context, userID model.UserID) (map[model.UserID]FriendItem, error)

	CheckIsFriendToOthers(ctx context.Context, selfID model.UserID, otherIDs ...model.UserID) (bool, error)

	GetFieldsByIDs(ctx context.Context, ids []model.UserID) (map[model.UserID]Fields, error)
}

func NewMysqlRepo

func NewMysqlRepo(q *query.Query, log *zap.Logger) (Repo, error)

type User

type User struct {
	RegistrationTime time.Time
	NickName         string
	Avatar           string
	Sign             string
	UserName         string
	ID               model.UserID
	UserGroup        GroupID
}

User is visible for everyone.

func (User) GetID

func (u User) GetID() model.UserID