← Bounded paged collections

Collection.Error

luastra/collection

Collection.Error represents the unsuccessful branch of a bounded operation. Its stable code and structured context support control flow and safe diagnostics without parsing an exception message.

Before you use it

Add luastra/collection to this module's dependencies in luastra.json, then import it with require("luastra/collection"). Choose a stable bounded key for every item and explicit maxItems, maxPages, and maxPageItems values appropriate to the screen. Provider cursors remain application state and must never be used as UI node IDs.

How it fits

Collection types describe pages, directions, tickets, bounded snapshots, results, and the state controller contract.

When to use it

Use Collection.Error on the unsuccessful branch of the related result. Read its stable fields for control flow or diagnostics; do not parse human-readable assertion or error text.

Fields or definition

ParameterType / valuesDescription
definitionResource.ErrorExact alias, union, or callable contract represented by Collection.Error.

What happens next

A checked page-window annotation for cursor-based ordered data.

Failures and fixes

Duplicate or malformed keys, oversized pages, repeated cursors, stale tickets, or invalid bounds are rejected without silently corrupting order. Edge failures remain separate so the existing window stays usable while the user retries only the failed direction.

Availability

Public-source alpha collection API in 0.5.0-alpha; fetching and viewport triggers remain explicit application and host concerns.

Exact declaration

export type Error = Resource.Error

Complete inventory

View all pages in Bounded paged collections
Next: Collection.Direction →