domain

package

v0.0.0-...-e365fa7 Latest Latest Go to latest Published: Apr 14, 2023 License: MIT Imports: 7 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/unknowntpo/page

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
type Article
type ListKey
- func GenerateListKeyByUserID(listKey ListKey, userID int64) ListKey
type Page
type PageKey
- func GeneratePageKeyByListKeyUserID(listKey ListKey, userID int64, now time.Time) PageKey
type PageMetaKey
- func GenerateListMetaKeyByUserID(listKey ListKey, userID int64) PageMetaKey
type PageRepo
type PageUsecase

Constants ¶

View Source

const (
	DefaultPageTTL time.Duration = 24 * time.Hour
)

Variables ¶

View Source

var (
	ErrInvalidUserID     = errors.New(errors.BadRequest, "userID should be greater than 0")
	ErrInvalidListKey    = errors.New(errors.BadRequest, "listKey can not be empty")
	ErrListAlreadyExists = errors.New(errors.ResourceAlreadyExist, "list already exist")
	ErrListNotFound      = errors.New(errors.ResourceNotFound, "list not found")
	ErrInternal          = errors.New(errors.Internal, "Internal Server Error")
	ErrPageNotFound      = errors.New(errors.ResourceNotFound, "page not found")
)

Errors defined by our domain

Functions ¶

This section is empty.

Types ¶

type Article ¶

type Article struct {
	Title   string
	Content string
}

type ListKey ¶

type ListKey string

func GenerateListKeyByUserID ¶

func GenerateListKeyByUserID(listKey ListKey, userID int64) ListKey

GenerateListKeyByUserID generates pageList (sorted set) redis key by listKey, userID, and have format pageList:{<listKey>:<userID>}

type Page ¶

type Page struct {
	Key     PageKey `json:"key"`
	Content string  `json:"content"`
	Next    PageKey `json:"next"`
}

func (*Page) GetJSONContent ¶

func (p *Page) GetJSONContent() string

func (*Page) Marshal ¶

func (p *Page) Marshal() []byte

func (*Page) SetContent ¶

func (p *Page) SetContent(c string)

func (*Page) String ¶

func (p *Page) String() string

type PageKey ¶

type PageKey string

func GeneratePageKeyByListKeyUserID ¶

func GeneratePageKeyByListKeyUserID(listKey ListKey, userID int64, now time.Time) PageKey

GeneratePageKeyByListKeyUserID generates given redis key by userID, listKey, and have format page:{<listKey>:<userID>}:<ulid>

type PageMetaKey ¶

type PageMetaKey string

func GenerateListMetaKeyByUserID ¶

func GenerateListMetaKeyByUserID(listKey ListKey, userID int64) PageMetaKey

GenerateListKeyByUserID generates pageList (sorted set) redis key by listKey, userID, and have format pageList:{<listKey>:<userID>}

type PageRepo ¶

type PageRepo interface {
	GetPage(ctx context.Context, uesrID int64, listKey ListKey, pageKey PageKey) (Page, error)
	GetHead(ctx context.Context, userID int64, listKey ListKey) (PageKey, error)
	SetPage(ctx context.Context, userID int64, listkey ListKey, page Page) (PageKey, error)
	NewList(ctx context.Context, userID int64, listKey ListKey) error
}

type PageUsecase ¶

type PageUsecase interface {
	GetPage(ctx context.Context, userID int64, listKey ListKey, pageKey PageKey) (Page, error)
	GetHead(ctx context.Context, userID int64, listKey ListKey) (PageKey, error)
	SetPage(ctx context.Context, userID int64, listKey ListKey, page Page) (PageKey, error)
	NewList(ctx context.Context, userID int64, listKey ListKey) error
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
mock Package mock is a generated GoMock package.	Package mock is a generated GoMock package.

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