Skip to content

HeadResult

Class: warmhub.HeadResult

HeadResult(items: Sequence[ThingItem[PayloadT]], next_cursor: str | None = None, repo_seq: int | None = None, extra: JsonMapping = _empty(), raw: JsonMapping = _empty())

One page of a list read.

Generic in the payload of the rows it carries: HeadResult[Reading] holds ThingItem[Reading].

as_dict()

The exact server payload as a plain, mutable, serializable dict.

Wire keys, wire nesting, no client naming applied — the same content as raw, in the form you can hand to dumps, mutate, or pass to code that demands a real dict. Built fresh on each call, so editing the result cannot reach the model.

items

Documentation is not yet available.

next_cursor = None

Documentation is not yet available.

repo_seq = None

The repository sequence a completed incremental scan reached.

Present only on the TERMINAL page of a read that passed since_repo_seq; None on every ordinary page and on every nonterminal one. thing.head_changes is what turns it into a checkpoint a caller can resume from.

extra = field(default_factory=_empty)

Documentation is not yet available.

raw = field(default_factory=_empty)

Documentation is not yet available.