page

Documentation

Index

• type Cursor
  • func NewCursor[T OrderField](size int, from *CursorKey, pos Position, orderBy OrderBy[T]) *Cursor[T]
  • func (c *Cursor[T]) SQLArguments() pgx.NamedArgs
  • func (c *Cursor[T]) SQLFragment() string
• type CursorKey
  • func NewCursorKey(id gid.GID, value any) CursorKey
  • func ParseCursorKey(s string) (CursorKey, error)
  • func (ck CursorKey) Bytes() []byte
  • func (ck CursorKey) FieldValue() any
  • func (ck CursorKey) MarshalBinary() ([]byte, error)
  • func (ck CursorKey) MarshalJSON() ([]byte, error)
  • func (ck CursorKey) MarshalText() ([]byte, error)
  • func (ck CursorKey) String() string
  • func (ck *CursorKey) UnmarshalBinary(data []byte) error
  • func (ck *CursorKey) UnmarshalJSON(data []byte) error
  • func (ck *CursorKey) UnmarshalText(data []byte) error
• type OrderBy
• type OrderDirection
  • func (od OrderDirection) MarshalText() ([]byte, error)
  • func (od OrderDirection) String() string
  • func (od *OrderDirection) UnmarshalText(data []byte) error
• type OrderField
• type Page
  • func NewPage[T Paginable[U], U OrderField](data []T, c *Cursor[U]) *Page[T, U]
  • func (p *Page[T, U]) First() T
  • func (p *Page[T, U]) Last() T
• type PageInfo
• type Paginable
• type Position
• type StringCursorKey

Types

type Cursor

type Cursor[T OrderField] struct {
	Size     int
	Position Position
	Key      *CursorKey
	OrderBy  OrderBy[T]
}

func NewCursor

func NewCursor[T OrderField](size int, from *CursorKey, pos Position, orderBy OrderBy[T]) *Cursor[T]

func (*Cursor[T]) SQLArguments

func (c *Cursor[T]) SQLArguments() pgx.NamedArgs

func (*Cursor[T]) SQLFragment

func (c *Cursor[T]) SQLFragment() string

type CursorKey

type CursorKey struct {
	ID    gid.GID
	Value any
}

var (
	CursorKeyNil CursorKey

	ErrInvalidFormat = errors.New("invalid format")
)

func NewCursorKey

func NewCursorKey(id gid.GID, value any) CursorKey

func ParseCursorKey

func ParseCursorKey(s string) (CursorKey, error)

func (CursorKey) Bytes

func (ck CursorKey) Bytes() []byte

func (CursorKey) FieldValue

func (ck CursorKey) FieldValue() any

func (CursorKey) MarshalBinary

func (ck CursorKey) MarshalBinary() ([]byte, error)

func (CursorKey) MarshalJSON

func (ck CursorKey) MarshalJSON() ([]byte, error)

func (CursorKey) MarshalText

func (ck CursorKey) MarshalText() ([]byte, error)

func (CursorKey) String

func (ck CursorKey) String() string

func (*CursorKey) UnmarshalBinary

func (ck *CursorKey) UnmarshalBinary(data []byte) error

func (*CursorKey) UnmarshalJSON

func (ck *CursorKey) UnmarshalJSON(data []byte) error

func (*CursorKey) UnmarshalText

func (ck *CursorKey) UnmarshalText(data []byte) error

type OrderBy

type OrderBy[T OrderField] struct {
	Field     T
	Direction OrderDirection
}

type OrderDirection

type OrderDirection string

const (
	OrderDirectionAsc  OrderDirection = "ASC"
	OrderDirectionDesc OrderDirection = "DESC"
)

func (OrderDirection) MarshalText

func (od OrderDirection) MarshalText() ([]byte, error)

func (OrderDirection) String

func (od OrderDirection) String() string

func (*OrderDirection) UnmarshalText

func (od *OrderDirection) UnmarshalText(data []byte) error

type OrderField

type OrderField interface {
	Column() string
	fmt.Stringer
}

type Page

type Page[T Paginable[U], U OrderField] struct {
	Info   *PageInfo
	Cursor *Cursor[U]
	Data   []T
}

func NewPage

func NewPage[T Paginable[U], U OrderField](data []T, c *Cursor[U]) *Page[T, U]

func (*Page[T, U]) First

func (p *Page[T, U]) First() T

func (*Page[T, U]) Last

func (p *Page[T, U]) Last() T

type PageInfo

type PageInfo struct {
	HasNext bool
	HasPrev bool
}

type Paginable

type Paginable[T OrderField] interface {
	CursorKey(orderBy T) CursorKey
}

type Position

type Position string

const (
	DefaultCursorSize = 25

	Tail Position = "TAIL"
	Head Position = "HEAD"
)

type StringCursorKey

type StringCursorKey struct {
	ID    string
	Value any
}

StringCursorKey is a cursor key for string IDs