pagination

type ControlRequest ¶

type ControlRequest interface {
	OnlyCountGetter
	NoPagingGetter
}

type CurrentGetter ¶

type CurrentGetter interface {
	GetCurrent() int32
}

CurrentGetter is the interface for getting the current page number.

type DataGetter ¶

type DataGetter interface {
	GetData() any
}

DataGetter is the interface for getting the data.

type DataResponse ¶

type DataResponse interface {
	TotalGetter
	DataGetter
	ExtraGetter
}

type ExtraGetter ¶

type ExtraGetter interface {
	GetExtra() any
}

ExtraGetter is the interface for getting the extra data.

type FieldMaskGetter ¶

type FieldMaskGetter interface {
	GetFieldMask() []string
}

FieldMaskGetter is the interface for getting the field mask.

type FilterRequest ¶

type FilterRequest interface {
	OrderByGetter
	FieldMaskGetter
}

type Limiter ¶

type Limiter struct {
	MaxPage         int32
	DefaultPage     int32
	MaxPageSize     int32
	DefaultPageSize int32
}

func DefaultLimiter() *Limiter

func NewLimiter(page, defaultPage, pageSize, defaultPageSize int32) *Limiter

func (obj Limiter) Current(in int32) int32

func (obj Limiter) PerPage(in int32) int32

type LimiterOption ¶

type LimiterOption = func(*Limiter)

func WithDefaultPage(page int32) LimiterOption

func WithDefaultPageSize(size int32) LimiterOption

func WithMaxPage(page int32) LimiterOption

func WithMaxPageSize(size int32) LimiterOption

type NextPageTokenGetter ¶

type NextPageTokenGetter interface {
	GetNextPageToken() string
}

NextPageTokenGetter is the interface for getting the next page token.

type NoPagingGetter ¶

type NoPagingGetter interface {
	GetNoPaging() bool
}

NoPagingGetter is the interface for checking if no paging is needed.

type OnlyCountGetter ¶

type OnlyCountGetter interface {
	GetOnlyCount() bool
}

OnlyCountGetter is the interface for checking if only count is needed.

type OrderByGetter ¶

type OrderByGetter interface {
	GetOrderBy() []string
}

OrderByGetter is the interface for getting the order by fields.

type PageLimiter ¶

type PageLimiter interface {
	Current(in int32) int32
	PerPage(in int32) int32
}

type PageRequest ¶

type PageRequest interface {
	CurrentGetter
	PageSizeGetter
	PageTokenGetter
}

type PageResponse ¶

type PageResponse interface {
	CurrentGetter
	PageSizeGetter
	NextPageTokenGetter
}

type PageSizeGetter ¶

type PageSizeGetter interface {
	GetPageSize() int32
}

PageSizeGetter is the interface for getting the page size.

type PageTokenGetter ¶

type PageTokenGetter interface {
	GetPageToken() string
}

PageTokenGetter is the interface for getting the page token.

type Requester ¶

type Requester interface {
	CurrentGetter
	PageSizeGetter
	PageTokenGetter
	OnlyCountGetter
	NoPagingGetter
	OrderByGetter
	FieldMaskGetter
}

Requester is the request interface for the module.

type Responder ¶

type Responder interface {
	SuccessGetter
	TotalGetter
	DataGetter
	CurrentGetter
	PageSizeGetter
	NextPageTokenGetter
	ExtraGetter
}

Responder is the response interface for the module.

type SuccessGetter ¶

type SuccessGetter interface {
	GetSuccess() bool
}

SuccessGetter is the interface for getting the success status.

type TotalGetter ¶

type TotalGetter interface {
	GetTotal() int32
}

TotalGetter is the interface for getting the total count.

type UnimplementedRequester ¶

type UnimplementedRequester struct{}

UnimplementedRequester is a struct that implements the Requester interface with empty methods.

func (u UnimplementedRequester) GetCurrent() int32

func (u UnimplementedRequester) GetFieldMask() []string

func (u UnimplementedRequester) GetNoPaging() bool

func (u UnimplementedRequester) GetOnlyCount() bool

func (u UnimplementedRequester) GetOrderBy() []string

func (u UnimplementedRequester) GetPageSize() int32

func (u UnimplementedRequester) GetPageToken() string

type UnimplementedResponder ¶

type UnimplementedResponder struct{}

UnimplementedResponder is a struct that implements the Responder interface with empty methods.

func (u UnimplementedResponder) GetCurrent() int32

func (u UnimplementedResponder) GetData() any

func (u UnimplementedResponder) GetExtra() any

func (u UnimplementedResponder) GetNextPageToken() string

func (u UnimplementedResponder) GetPageSize() int32

func (u UnimplementedResponder) GetSuccess() bool

func (u UnimplementedResponder) GetTotal() int32