SyncReader

Signals close from the consumer side. Implementations should set internal closed state and wake any blocked readers.

true once the reader is closed. Reflects the state machine; does not imply the buffer is empty.

Reads the next element, or returns sentinel if the stream is closed. The caller passes a sentinel value that can never appear as a real element; getting it back means the stream is exhausted.

Alias for concat.

Fails immediately with a trusted typed source error.

The primitive type of elements in this reader, or AnyRef for reference types. Specialized subclasses override this to enable zero-boxing pull paths via readIntPhysical(), readLongPhysical(), etc.

Drains this reader into a Chunk, consuming all remaining elements. Returns Chunk.empty when already at EOF. Dispatches on jvmType for zero-boxing on primitive streams.

Sentinel-return Boolean pull. Returns 1 for true, 0 for false, or sentinel when closed and empty. Sentinel must be outside [0, 1]. A typical sentinel is -1. Requires implicit evidence that Elem is a subtype of Boolean.

Reads a single byte, returning -1 when closed. Default delegates to read and extracts the low byte. Byte-specialized readers override for efficiency.

Box-free bulk byte pull into a caller-supplied buffer. Requires compile-time evidence that this reader's element type is Byte.

Contract mirrors java.io.InputStream.read(byte[], int, int):

• Blocks until at least 1 byte is available.
• Returns the number of bytes read (`1 0) process(buf, 0, n) }}}

Sentinel-return Char pull. Returns element widened to Int, or sentinel when closed. Requires implicit evidence that Elem is a subtype of Char.

Sentinel-return Double pull. Returns element widened/exact, or sentinel when closed. Requires implicit evidence that Elem is a subtype of Double.

Box-free bulk Double pull into a caller-supplied buffer.

Contract mirrors readBytes:

• Blocks until at least 1 element is available.
• Returns the number of elements read (1 <= r <= maxLen).
• Returns -1 when closed and empty.
• Returns 0 immediately when maxLen == 0.

Sentinel-return Float pull. Returns element widened to Double, or sentinel when closed. Requires implicit evidence that Elem is a subtype of Float.

Box-free bulk Float pull into a caller-supplied buffer.

Contract mirrors readBytes:

• Blocks until at least 1 element is available.
• Returns the number of elements read (1 <= r <= maxLen).
• Returns -1 when closed and empty.
• Returns 0 immediately when maxLen == 0.

Sentinel-return Int pull. Returns the element widened to Long, or sentinel when closed and empty. The sentinel must lie outside [Int.MinValue, Int.MaxValue] (e.g. Long.MinValue). Requires implicit evidence that Elem is a subtype of Int.

Box-free bulk Int pull into a caller-supplied buffer.

Contract mirrors readBytes:

• Blocks until at least 1 element is available.
• Returns the number of elements read (1 <= r <= maxLen).
• Returns -1 when closed and empty.
• Returns 0 immediately when maxLen == 0.

Sentinel-return Long pull. Returns the element, or sentinel when closed and empty. The sentinel must be a value that never appears in the stream (e.g. Long.MaxValue). Requires implicit evidence that Elem is a subtype of Long.

Box-free bulk Long pull into a caller-supplied buffer.

Contract mirrors readBytes:

• Blocks until at least 1 element is available.
• Returns the number of elements read (1 <= r <= maxLen).
• Returns -1 when closed and empty.
• Returns 0 immediately when maxLen == 0.

Reads at most n elements into a Chunk, returning early if the reader is exhausted. Returns Chunk.empty when n <= 0 or the reader is already closed. Dispatches on jvmType for zero-boxing on primitive streams.

Sentinel-return Short pull. Returns element widened to Int, or sentinel when closed. Requires implicit evidence that Elem is a subtype of Short.

Reads up to n elements that are currently available. Blocks for at least 1 element if none are ready yet. Returns fewer than n if fewer are available without additional blocking. Returns Chunk.empty if n <= 0 or if the reader is closed and empty.

Differs from readN in that readN blocks until exactly n elements have been read. readUpToN returns as soon as at least one element is read, without waiting for further elements.

Returns true if the next read() / readIntPhysical() etc. would return a value (not closed/sentinel). Default implementation returns !isClosed. Subclasses with buffered state should override for accuracy.

Rewinds this reader to its initial state, as if freshly constructed. After reset(), all elements are available again from the beginning.

Not all readers support this. Readers backed by one-shot resources (InputStreams, java.io.Readers) throw UnsupportedOperationException.

Attempts to set a limit on this reader so it produces at most n elements. Returns true if the reader handled it natively (O(1), zero per-element cost), false if it cannot. When true, the reader will produce at most limit elements before reporting closed. After reset(), the limit is re-applied from the new start position.

Default returns false — most readers don't support native pushdown.

Attempts to set this reader into repeat-forever mode, so it restarts from the beginning whenever it would otherwise close. Returns true if the reader handled it natively, false if the caller must wrap in a repeating wrapper.

Default returns false.

Attempts to set a skip (drop) on this reader. Returns true if the reader handled it natively (O(1), zero per-element cost), false if it cannot. When true, the next skip elements will be skipped before producing. After reset(), the skip is re-applied.

Default returns false — most readers don't support native pushdown.

Eagerly discards the first n elements. Returns Unit. If the stream closes before n elements, returns early. Subclasses should override for efficient skipping (e.g. index advancement).

Constructs a trusted typed source failure for custom Reader implementations.

Wraps this reader so that release runs after close().