pagination

Documentation

Index

• type Bag
  • func (pb *Bag) Current() *PageState
  • func (pb *Bag) Marshal() (string, error)
  • func (pb *Bag) Next(pageToken string) error
  • func (pb *Bag) NextToken(pageToken string) (string, error)
  • func (pb *Bag) PageToken() string
  • func (pb *Bag) Pop() *PageState
  • func (pb *Bag) Push(state PageState)
  • func (pb *Bag) ResourceID() string
  • func (pb *Bag) ResourceTypeID() string
  • func (pb *Bag) Unmarshal(input string) error
• type PageState
• type StreamState
• type StreamToken
• type Token

Types

type Bag

type Bag struct {
	// contains filtered or unexported fields
}

Bag holds pagination states that can be serialized for use as page tokens. It acts as a stack that you can push and pop pagination operations from.

func (*Bag) Current

func (pb *Bag) Current() *PageState

Current returns the current page state for the bag.

func (*Bag) Marshal

func (pb *Bag) Marshal() (string, error)

Marshal returns a string encoding of the state object.

func (*Bag) Next

func (pb *Bag) Next(pageToken string) error

Next pops the current token, and pushes a copy of it with an updated page token.

func (*Bag) NextToken

func (pb *Bag) NextToken(pageToken string) (string, error)

Next pops the current token, and pushes a copy of it with an updated page token.

func (*Bag) PageToken

func (pb *Bag) PageToken() string

PageToken returns the page token for the current state.

func (*Bag) Pop

func (pb *Bag) Pop() *PageState

Pop returns the current page action, and makes the top of the stack the current.

func (*Bag) Push

func (pb *Bag) Push(state PageState)

Push pushes a new page state onto the stack.

func (*Bag) ResourceID

func (pb *Bag) ResourceID() string

ResourceID returns the resource ID for the current state.

func (*Bag) ResourceTypeID

func (pb *Bag) ResourceTypeID() string

ResourceTypeID returns the resource type id for the current state.

func (*Bag) Unmarshal

func (pb *Bag) Unmarshal(input string) error

Unmarshal takes an input string and unmarshals it onto the state object.

type PageState

type PageState struct {
	Token          string `json:"token"`
	ResourceTypeID string `json:"resource_type_id"`
	ResourceID     string `json:"resource_id"`
}

type StreamState

type StreamState struct {
	Cursor  string `json:"cursor"`
	HasMore bool   `json:"done"`
}

type StreamToken

type StreamToken struct {
	Size   int
	Cursor string
}

type Token

type Token struct {
	Size  int
	Token string
}