paging

package
v0.0.8-beta Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 6, 2022 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	DefaultPageSize     = 10
	PageStartQueryParam = "s"
	PageEndQueryParam   = "e"
	PageSizeQueryParam  = "l"
)
View Source
var File_proto_paging_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Page

type Page interface {
	Size() int
	Query(query *url.Values)
}

func FromQuery

func FromQuery(c *gin.Context) Page

type PageSpec

type PageSpec struct {

	// Types that are assignable to Page:
	//	*PageSpec_First
	//	*PageSpec_Prev
	//	*PageSpec_Next
	//	*PageSpec_Cur
	Page isPageSpec_Page `protobuf_oneof:"page"`
	// contains filtered or unexported fields
}

func (*PageSpec) Descriptor deprecated

func (*PageSpec) Descriptor() ([]byte, []int)

Deprecated: Use PageSpec.ProtoReflect.Descriptor instead.

func (*PageSpec) GetCur

func (x *PageSpec) GetCur() *Paging_Current

func (*PageSpec) GetFirst

func (x *PageSpec) GetFirst() *Paging_First

func (*PageSpec) GetNext

func (x *PageSpec) GetNext() *Paging_Next

func (*PageSpec) GetPage

func (m *PageSpec) GetPage() isPageSpec_Page

func (*PageSpec) GetPrev

func (x *PageSpec) GetPrev() *Paging_Previous

func (*PageSpec) ProtoMessage

func (*PageSpec) ProtoMessage()

func (*PageSpec) ProtoReflect

func (x *PageSpec) ProtoReflect() protoreflect.Message

func (*PageSpec) Reset

func (x *PageSpec) Reset()

func (*PageSpec) String

func (x *PageSpec) String() string

type PageSpec_Cur

type PageSpec_Cur struct {
	Cur *Paging_Current `protobuf:"bytes,4,opt,name=cur,proto3,oneof"`
}

type PageSpec_First

type PageSpec_First struct {
	First *Paging_First `protobuf:"bytes,1,opt,name=first,proto3,oneof"`
}

type PageSpec_Next

type PageSpec_Next struct {
	Next *Paging_Next `protobuf:"bytes,3,opt,name=next,proto3,oneof"`
}

type PageSpec_Prev

type PageSpec_Prev struct {
	Prev *Paging_Previous `protobuf:"bytes,2,opt,name=prev,proto3,oneof"`
}

type Paging

type Paging struct {
	Prev *Paging_Previous `protobuf:"bytes,1,opt,name=prev,proto3" json:"prev,omitempty"`
	Cur  *Paging_Current  `protobuf:"bytes,2,opt,name=cur,proto3" json:"cur,omitempty"`
	Next *Paging_Next     `protobuf:"bytes,3,opt,name=next,proto3" json:"next,omitempty"`
	// contains filtered or unexported fields
}

func (*Paging) Descriptor deprecated

func (*Paging) Descriptor() ([]byte, []int)

Deprecated: Use Paging.ProtoReflect.Descriptor instead.

func (*Paging) GetCur

func (x *Paging) GetCur() *Paging_Current

func (*Paging) GetNext

func (x *Paging) GetNext() *Paging_Next

func (*Paging) GetPrev

func (x *Paging) GetPrev() *Paging_Previous

func (*Paging) ProtoMessage

func (*Paging) ProtoMessage()

func (*Paging) ProtoReflect

func (x *Paging) ProtoReflect() protoreflect.Message

func (*Paging) Reset

func (x *Paging) Reset()

func (*Paging) String

func (x *Paging) String() string

type Paging_Current

type Paging_Current struct {
	Start    string `protobuf:"bytes,1,opt,name=start,proto3" json:"start,omitempty"`        // Start of the a page idenfied by the first item's ID.
	End      string `protobuf:"bytes,2,opt,name=end,proto3" json:"end,omitempty"`            // End of the a page idenfied by the last item's ID.
	PageSize int32  `protobuf:"varint,3,opt,name=pageSize,proto3" json:"pageSize,omitempty"` // The size (number of items) of a page.
	// contains filtered or unexported fields
}

func (*Paging_Current) Descriptor deprecated

func (*Paging_Current) Descriptor() ([]byte, []int)

Deprecated: Use Paging_Current.ProtoReflect.Descriptor instead.

func (*Paging_Current) GetEnd

func (x *Paging_Current) GetEnd() string

func (*Paging_Current) GetPageSize

func (x *Paging_Current) GetPageSize() int32

func (*Paging_Current) GetStart

func (x *Paging_Current) GetStart() string

func (*Paging_Current) Next

func (p *Paging_Current) Next() Paging_Next

func (*Paging_Current) Prev

func (p *Paging_Current) Prev() Paging_Previous

func (*Paging_Current) ProtoMessage

func (*Paging_Current) ProtoMessage()

func (*Paging_Current) ProtoReflect

func (x *Paging_Current) ProtoReflect() protoreflect.Message

func (*Paging_Current) Query

func (f *Paging_Current) Query(query *url.Values)

func (*Paging_Current) Reset

func (x *Paging_Current) Reset()

func (*Paging_Current) Size

func (f *Paging_Current) Size() int

func (*Paging_Current) String

func (x *Paging_Current) String() string

type Paging_First

type Paging_First struct {
	PageSize int32 `protobuf:"varint,1,opt,name=pageSize,proto3" json:"pageSize,omitempty"` // The size (number of items) of the first page.
	// contains filtered or unexported fields
}

First describes the first page of a collection of items.

It's no more than a wrapped page size.

func (*Paging_First) Descriptor deprecated

func (*Paging_First) Descriptor() ([]byte, []int)

Deprecated: Use Paging_First.ProtoReflect.Descriptor instead.

func (*Paging_First) GetPageSize

func (x *Paging_First) GetPageSize() int32

func (*Paging_First) ProtoMessage

func (*Paging_First) ProtoMessage()

func (*Paging_First) ProtoReflect

func (x *Paging_First) ProtoReflect() protoreflect.Message

func (*Paging_First) Query

func (f *Paging_First) Query(query *url.Values)

func (*Paging_First) Reset

func (x *Paging_First) Reset()

func (*Paging_First) Size

func (f *Paging_First) Size() int

func (*Paging_First) String

func (x *Paging_First) String() string

type Paging_Next

type Paging_Next struct {
	Start string `protobuf:"bytes,1,opt,name=start,proto3" json:"start,omitempty"` // Start of the next page idenfied by the last item's ID on the
	// preceding page (usually equals to the current page).
	PageSize int32 `protobuf:"varint,2,opt,name=pageSize,proto3" json:"pageSize,omitempty"` // The size (number of items) of a next page.
	// contains filtered or unexported fields
}

A Next describes the next page of the current one.

It does not explicitely identify the last item to be stable upon inserts.

func (*Paging_Next) Descriptor deprecated

func (*Paging_Next) Descriptor() ([]byte, []int)

Deprecated: Use Paging_Next.ProtoReflect.Descriptor instead.

func (*Paging_Next) GetPageSize

func (x *Paging_Next) GetPageSize() int32

func (*Paging_Next) GetStart

func (x *Paging_Next) GetStart() string

func (*Paging_Next) ProtoMessage

func (*Paging_Next) ProtoMessage()

func (*Paging_Next) ProtoReflect

func (x *Paging_Next) ProtoReflect() protoreflect.Message

func (*Paging_Next) Query

func (f *Paging_Next) Query(query *url.Values)

func (*Paging_Next) Reset

func (x *Paging_Next) Reset()

func (*Paging_Next) Size

func (f *Paging_Next) Size() int

func (*Paging_Next) String

func (x *Paging_Next) String() string

type Paging_Previous

type Paging_Previous struct {
	End string `protobuf:"bytes,1,opt,name=end,proto3" json:"end,omitempty"` // End of the previous page idenfied by the first item's ID on the
	// successing page (usually equals to the current page).
	PageSize int32 `protobuf:"varint,2,opt,name=pageSize,proto3" json:"pageSize,omitempty"` // The size (number of items) of a previous page.
	// contains filtered or unexported fields
}

A Previous describes the previous page of the current one.

It does not explicitely identify the first item to be stable upon inserts.

func (*Paging_Previous) Descriptor deprecated

func (*Paging_Previous) Descriptor() ([]byte, []int)

Deprecated: Use Paging_Previous.ProtoReflect.Descriptor instead.

func (*Paging_Previous) GetEnd

func (x *Paging_Previous) GetEnd() string

func (*Paging_Previous) GetPageSize

func (x *Paging_Previous) GetPageSize() int32

func (*Paging_Previous) ProtoMessage

func (*Paging_Previous) ProtoMessage()

func (*Paging_Previous) ProtoReflect

func (x *Paging_Previous) ProtoReflect() protoreflect.Message

func (*Paging_Previous) Query

func (f *Paging_Previous) Query(query *url.Values)

func (*Paging_Previous) Reset

func (x *Paging_Previous) Reset()

func (*Paging_Previous) Size

func (f *Paging_Previous) Size() int

func (*Paging_Previous) String

func (x *Paging_Previous) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL