ripper

README

ripper

Documentation

Index

• func Paginate(p *PaginateParams, pageToken string, totalSize int64) (offset int, limit int, nextPageToken string, err error)
• func SetDefaultPageSize(pageSize int) bool
• func SetMaxPageSize(pageSize int) bool
• type IPaginateParams
• type PaginateParams
  • func Itop(i IPaginateParams) (p *PaginateParams)
  • func NewPaginateParams(page int, parent string, pageSize int, orderBy string, filter string) *PaginateParams
• type PaginationError

Functions

func Paginate

func Paginate(p *PaginateParams, pageToken string, totalSize int64) (offset int, limit int, nextPageToken string, err error)

Paginate the results by page_token, returns offset, limit and next_page_token.

func SetDefaultPageSize

func SetDefaultPageSize(pageSize int) bool

SetDefaultPageSize sets the default value of pageSize.

func SetMaxPageSize

func SetMaxPageSize(pageSize int) bool

SetMaxPageSize sets the max limit to pageSize.

Types

type IPaginateParams

type IPaginateParams interface {
	GetParent() string
	GetPageSize() int32
	GetPageToken() string
	GetOrderBy() string
	GetFilter() string
}

IPaginateParams is an interface for paginate params.

type PaginateParams

type PaginateParams struct {
	Page     int
	Parent   string
	PageSize int
	OrderBy  string
	Filter   string
}

PaginateParams is the request params for pagination.

func Itop

func Itop(i IPaginateParams) (p *PaginateParams)

Itop converts IPaginateParams to PaginateParams.

func NewPaginateParams

func NewPaginateParams(page int, parent string, pageSize int, orderBy string, filter string) *PaginateParams

NewPaginateParams returns a PaginateParams pointer.

type PaginationError

type PaginationError interface {
	error
	Field() string
	// contains filtered or unexported methods
}

PaginationError is an interface for pagination error.