cursortoken

Documentation

Index

• type CTKeySort
  • func (c CTKeySort) IsEnd() bool
  • func (c CTKeySort) IsStart() bool
  • func (c CTKeySort) Token() string
• type CTPaginated
  • func (c CTPaginated) IsEnd() bool
  • func (c CTPaginated) IsStart() bool
  • func (c CTPaginated) Token() string
• type CursorToken
  • func Decode(tok string) (CursorToken, error)
  • func End() CursorToken
  • func NewKeySortToken(valuePrimary string, valueSecondary string, direction SortDirection, ...) CursorToken
  • func Page(p int) CursorToken
  • func PageEnd() CursorToken
  • func Start() CursorToken
• type Extra
• type Filter
• type Mode
• type RawFilter
• type SortDirection
  • func (sd SortDirection) ToMongo() int

Types

type CTKeySort

type CTKeySort struct {
	Mode               Mode
	ValuePrimary       string
	ValueSecondary     string
	Direction          SortDirection
	DirectionSecondary SortDirection
	PageSize           int
	Extra              Extra
}

func (CTKeySort) IsEnd

func (c CTKeySort) IsEnd() bool

func (CTKeySort) IsStart

func (c CTKeySort) IsStart() bool

func (CTKeySort) Token

func (c CTKeySort) Token() string

type CTPaginated

type CTPaginated struct {
	Mode Mode
	Page int
}

func (CTPaginated) IsEnd

func (c CTPaginated) IsEnd() bool

func (CTPaginated) IsStart

func (c CTPaginated) IsStart() bool

func (CTPaginated) Token

func (c CTPaginated) Token() string

type CursorToken

type CursorToken interface {
	Token() string
	IsStart() bool
	IsEnd() bool
}

func Decode

func Decode(tok string) (CursorToken, error)

func End

func End() CursorToken

func NewKeySortToken

func NewKeySortToken(valuePrimary string, valueSecondary string, direction SortDirection, directionSecondary SortDirection, pageSize int, extra Extra) CursorToken

func Page

func Page(p int) CursorToken

func PageEnd

func PageEnd() CursorToken

func Start

func Start() CursorToken

type Extra

type Extra struct {
	Timestamp *time.Time
	Id        *string
	Page      *int
	PageSize  *int
}

type Filter

type Filter interface {
	FilterQuery(ctx context.Context) mongo.Pipeline
	Pagination(ctx context.Context) (string, SortDirection, string, SortDirection)
}

type Mode

type Mode string

const (
	CTMStart  Mode = "START"
	CTMNormal Mode = "NORMAL"
	CTMEnd    Mode = "END"
)

type RawFilter

type RawFilter interface {
	FilterQuery(ctx context.Context) mongo.Pipeline
}

type SortDirection

type SortDirection string //@enum:type

const (
	SortASC  SortDirection = "ASC"
	SortDESC SortDirection = "DESC"
)

func (SortDirection) ToMongo

func (sd SortDirection) ToMongo() int