Skip to main content

Module read

Module read 

Source

Structs§

AckReceipt
A stored acknowledgment.
AppliedPolicy
The filter a page actually executed.
Continuation
The resume point a page hands to the next request.
ExplainNode
One node of an explanation tree: what it tested and how it resolved. truth is absent when the payload could not be decoded for this node.
FilterDecodeLimits
Decoder limits applied by the server to unevaluated records in a page.
FilterError
A consumer-filter failure.
FilterExplanation
Why a record was or was not selected.
FilterHeader
One user header of a record.
FilterPreview
A preview of one partition range.
FilterPreviewRequest
Preview a filter over stored records of one partition. Observational: it joins no group, stores no offset, and changes no consumer state.
FilterSource
The stream and topic a filtered read or preview addresses, by name.
FilterTestRequest
Evaluate a filter against one supplied record. Nothing is read from a stream and nothing is stored.
FilterTestResult
The result of a sample test.
FilterValidation
A filter that validated and compiled.
FilteredAck
Acknowledge a filtered page through its safe offset. The server stores the offset only while the source still has the generation the page was read from, and only while the consumer still owns the partition.
FilteredPage
One page of a filtered read.
FilteredPollRequest
Read one bounded page of matching records from one partition.
PreviewRecord
One previewed record: identity, verdict, and a bounded text view.
RecordFault
One record the filter could not evaluate.
SourceGeneration
The exact source history a page was read from. A purge or a recreated stream, topic, or partition changes it, so a continuation or acknowledgment from an older history is rejected rather than applied to new records.

Enums§

ExecutionMode
How the server selected the records of a page. Unfiltered is the explicit policy of a group without a binding, never a fallback: it carries no digest and the page holds every record the owner read returned.
FaultReason
Why a record could not be evaluated.
FilterConsumer
Whose progress a filtered read follows: an independent consumer or a consumer group. Groups accept either a name or a numeric ID.
FilterErrorReason
The typed cause of a consumer-filter failure. Each maps to one shared ResultCode, so a generic client can still classify it.
FilterOutcome
A successful reply of a server-native consumer-filter command.
FilterRef
Which filter a read executes.
FilterReply
The reply to every server-native consumer-filter command.
FilteredStart
Where a filtered read starts.
HeaderScalar
A typed user header value, as the evaluator reads it. Iggy integer kinds up to 64 bits map to int or uint. 128-bit integers arrive as raw bytes.
ReadMode
Which replica serves the read.
StopReason
Why a page stopped scanning.
Truth
Three-valued comparison truth.
Verdict
How the filter judged one previewed record.