page_token

Documentation

Index

• Variables
• func SetMaxElements(max int) options.Option
• func SetMaxIndex(max int) options.Option
• func SetSalt(salt string) options.Option
• func SetTimeLimitation(d time.Duration) options.Option
• type PageToken
  • func NewTokenGenerate(resourceIdentification string, options ...options.Option) PageToken
• type ProcessPageTokens
• type TokenGenerator

Variables

var (
	ErrInvalidToken         = errors.New("the field `page_token` is invalid")
	ErrOverdueToken         = errors.New("the field `page_token` is overdue")
	ErrOverMaxPageSizeToken = errors.New("the field `page_token` is over max page size")
	ErrInvalidPageSize      = errors.New("the page size provided must not be negative")
)

Functions

func SetMaxElements

func SetMaxElements(max int) options.Option

func SetMaxIndex

func SetMaxIndex(max int) options.Option

func SetSalt

func SetSalt(salt string) options.Option

func SetTimeLimitation

func SetTimeLimitation(d time.Duration) options.Option

Types

type PageToken

type PageToken interface {
	TokenGenerator
	ProcessPageTokens
}

func NewTokenGenerate

func NewTokenGenerate(resourceIdentification string, options ...options.Option) PageToken

type ProcessPageTokens

type ProcessPageTokens interface {
	ProcessPageTokens(numElements int, pageSize int, pageToken string) (start, end int, nextToken string, err error)
}

type TokenGenerator

type TokenGenerator interface {
	ForIndex(int) string
	GetIndex(string) (int, error)
}