tiny.acp.ReaderStatus
Defined in tiny.acp.
A caller uses this snapshot to report how the reader is doing, or to explain why it stopped.
API (7)
Fields and members
Public fields and members.
buffered_byteshigh_water_message_bytesmessage_bytesphaserejected_message_countstorage_bytesterminal
Source
Source: lib/acp/src/reader/storage.zig:33
zig
/// A caller uses this snapshot to report how the reader is doing, or to explain why it stopped. The/// struct records a snapshot of the reader's lifecycle step, sizes and counters. Both/// `Storage.status` and `Client.readerStatus` return it. The package exports the type as/// `acp.ReaderStatus`. The lifecycle step is initialization after `init`, steady after `activate`,/// and teardown after `deinit`.pub const Status = struct { /// The reader's lifecycle step (phase) when the snapshot was taken. phase: alloc_phase.capacity.Phase, /// The line limit, in bytes. message_bytes: usize, /// The buffer size, the line limit plus one byte. storage_bytes: usize, /// The bytes read in but not yet returned as lines. buffered_bytes: usize, /// Records the longest line seen, capped at the limit (high-water mark), in bytes. The value /// equals the limit once a line has run past it. A partial line still waiting for its newline /// counts toward this size too, up to the limit. high_water_message_bytes: usize, /// Records the number of lines rejected for running past the limit. The count stops rising at /// the largest `u64`. The first rejection leaves the reader stopped for good (terminal), so in /// normal use the count is 0 or 1. rejected_message_count: u64, /// Reports true once a line has run past the limit, and every later poll fails. terminal: bool,};Source: lib/acp/src/root.zig:90
zig
pub const ReaderStatus = reader.Status;Also reachable as
Audit
| Definitions | 1 |
|---|---|
| Public names | 2 |
| Members | 7 |
| Version | 26.7.0 |
| Revision | daab053ee433 |