cursortoken

Documentation

Index

• type CursorToken
  • func Decode(tok string) (CursorToken, error)
  • func End() CursorToken
  • func Start() CursorToken
  • func (c *CursorToken) Token() string
  • func (c *CursorToken) ValuePrimaryObjectId() (primitive.ObjectID, bool)
  • func (c *CursorToken) ValueSecondaryObjectId() (primitive.ObjectID, bool)
• type Extra
• type Filter
• type Mode
• type RawFilter
• type SortDirection

Types

type CursorToken

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

func Decode

func Decode(tok string) (CursorToken, error)

func End

func End() CursorToken

func Start

func Start() CursorToken

func (*CursorToken) Token

func (c *CursorToken) Token() string

func (*CursorToken) ValuePrimaryObjectId

func (c *CursorToken) ValuePrimaryObjectId() (primitive.ObjectID, bool)

func (*CursorToken) ValueSecondaryObjectId

func (c *CursorToken) ValueSecondaryObjectId() (primitive.ObjectID, bool)

type Extra

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

type Filter

type Filter interface {
	FilterQuery() mongo.Pipeline
	Pagination() (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() mongo.Pipeline
}

type SortDirection

type SortDirection string //@enum:type

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