ormlist

Documentation

Overview

Package ormlist defines options for listing items from ORM indexes.

Index

• type CursorT
• type Option
  • func Cursor(cursor CursorT) Option
  • func Filter(filterFn func(message proto.Message) bool) Option
  • func Paginate(pageRequest *queryv1beta1.PageRequest) Option
  • func Reverse() Option

Types

type CursorT

type CursorT []byte

CursorT defines a cursor type.

type Option

type Option = listinternal.Option

Option represents a list option.

func Cursor

func Cursor(cursor CursorT) Option

Cursor specifies a cursor after which to restart iteration. Cursor values are returned by iterators and in pagination results.

func Filter

func Filter(filterFn func(message proto.Message) bool) Option

Filter returns an option which applies a filter function to each item and skips over it when the filter function returns false.

func Paginate

func Paginate(pageRequest *queryv1beta1.PageRequest) Option

Paginate paginates iterator output based on the provided page request. The Iterator.PageRequest value on the returned iterator will be non-nil after Iterator.Next() returns false when this option is provided. Care should be taken when using Paginate together with Reverse and/or Cursor and generally this should be avoided.

func Reverse

func Reverse() Option

Reverse reverses the direction of iteration. If Reverse is provided twice, iteration will happen in the forward direction.