cursor

package

v0.13.1 Latest Latest Go to latest Published: Feb 20, 2026 License: Apache-2.0 Imports: 4 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/hookdeck/outpost

Links

Documentation ¶

Overview ¶

Package cursor provides a unified cursor encoding/decoding utility for pagination. Cursors are versioned and resource-scoped, allowing different parts of the system to use cursors without collision.

Index ¶

Variables
func Base62Decode(s string) (string, error)
func Base62Encode(s string) string
func Decode(encoded string, resource string, version int) (string, error)
func Encode(resource string, version int, data string) string

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ErrInvalidCursor indicates the cursor is malformed or cannot be decoded.
	ErrInvalidCursor = errors.New("invalid cursor")

	// ErrVersionMismatch indicates the cursor version doesn't match the expected version.
	ErrVersionMismatch = errors.New("cursor version mismatch")
)

Functions ¶

func Decode ¶

func Decode(encoded string, resource string, version int) (string, error)

Decode decodes and validates a cursor string. Returns the data portion if the cursor matches the expected resource and version. Returns ErrInvalidCursor if the cursor is malformed. Returns ErrVersionMismatch if the version doesn't match.

func Encode ¶

func Encode(resource string, version int, data string) string

Encode creates a versioned cursor string. Format: {resource}v{version:02d}:{data}, then base62 encoded. Example: "evtv01:position_data" -> base62

Types ¶