Struct PageSignal 

pub struct PageSignal {
    pub partial: bool,
    pub next_cursor: Option<String>,
    pub scanned: Option<u64>,
    pub covers_from: Option<String>,
}

What a bounded reply says about itself (RFC 05 §3.2, v1.31): the envelope’s partial flag and the three fields that qualify it.

Derived, not serialized. The wire already carries the envelope inside CallOutcome::Ok’s value; this is the renderer’s reading of it, so it has no serde derive and no place in the pinned contract — a script that wants the flag reads the reply it is in.

Some only when the reply is a JSON object carrying a boolean partial — which is the envelope’s one required marker. A procedure that replies with a bare list, a scalar, or TOML text (the introspect procedures) is not paginated and gets no signal at all rather than a synthetic partial: false: an absent envelope and a complete walk are different facts, and the caller must not be told the second when only the first is known.

Fields

partial: bool

The producer stopped before completing the walk — scan cap, tier coverage, time budget — and a short page is not the end.

next_cursor: Option<String>

Non-null means more; null means the walk is complete for the filter given. Opaque to the caller (a value cursor, never a position).

scanned: Option<u64>

Advisory: what the page cost, so an expensive empty page can be told from a cheap one. Omitted by procedures that do not count.

covers_from: Option<String>

The oldest instant the answer could have covered, for a computed answer narrower than what was asked. Omitted by procedures with no notion of coverage.

Implementations

impl PageSignal

pub fn is_contract_violation(&self) -> bool

partial: true with next_cursor: null: the producer says it stopped early and offers no way on. RFC 05 §3.2 names this a contract violation an observer MAY report (RFC 13 §3); zenctl call says it as a caveat and does not move the exit code, because a call is an act, not a judgement (#424).

Trait Implementations

impl Clone for PageSignal

fn clone(&self) -> PageSignal

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PageSignal

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for PageSignal

impl PartialEq for PageSignal

fn eq(&self, other: &PageSignal) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for PageSignal