page

Documentation

Index

• func Limit(ctx context.Context) limitOffset
• func Offset(ctx context.Context) limitOffset
• func Token(ctx context.Context) string
• func WithLimit(ctx context.Context, limitStr string) context.Context
• func WithOffset(ctx context.Context, offsetStr string) context.Context
• func WithToken(ctx context.Context, token string) context.Context
• type Links
• type Metadata
  • func NewOffsetMetadata(ctx context.Context, r *http.Request, total int) *Metadata
  • func NewTokenMetadata(ctx context.Context, r *http.Request, nextToken string) *Metadata

Functions

func Limit

func Limit(ctx context.Context) limitOffset

func Offset

func Offset(ctx context.Context) limitOffset

func Token

func Token(ctx context.Context) string

func WithLimit

func WithLimit(ctx context.Context, limitStr string) context.Context

WithLimit returns context copy with limit value.

func WithOffset

func WithOffset(ctx context.Context, offsetStr string) context.Context

WithOffset returns context copy with offset value.

func WithToken

func WithToken(ctx context.Context, token string) context.Context

WithToken returns context copy with token value.

Types

type Links

type Links struct {
	Previous string `json:"previous"`
	Next     string `json:"next"`
}

type Metadata

type Metadata struct {
	Total int   `json:"total,omitempty"`
	Links Links `json:"links,omitempty"`
}

func NewOffsetMetadata

func NewOffsetMetadata(ctx context.Context, r *http.Request, total int) *Metadata

func NewTokenMetadata

func NewTokenMetadata(ctx context.Context, r *http.Request, nextToken string) *Metadata