pagination

Documentation

Index

• func InvalidToken(err error) error
• func ParseToken(token string) ([]string, error)
• func Token(pos ...string) string
• func ValidatePageSize(pageSize int32) error
• type PageSizeLimiter
  • func (psl *PageSizeLimiter) Adjust(pageSize int32) int32

Functions

func InvalidToken

func InvalidToken(err error) error

InvalidToken annotates the error with InvalidArgument appstatus.

func ParseToken

func ParseToken(token string) ([]string, error)

ParseToken extracts a string slice position from the given page token. May return an appstatus-annotated error.

func Token

func Token(pos ...string) string

Token converts an string slice representing page token position to an opaque token string.

func ValidatePageSize

func ValidatePageSize(pageSize int32) error

ValidatePageSize returns a non-nil error if pageSize is invalid. Returns nil if pageSize is 0.

Types

type PageSizeLimiter

type PageSizeLimiter struct {
	Max     int32
	Default int32
}

func (*PageSizeLimiter) Adjust

func (psl *PageSizeLimiter) Adjust(pageSize int32) int32

Adjust the requested pageSize according to PageSizeLimiter.Max and PageSizeLimiter.Default as necessary.