LLM docs

Stdin

Err

EndOfFile - This error occurs when an end-of-file (EOF) condition is met unexpectedly during input operations. Typically indicates that no more data is available for reading.

BrokenPipe - This error happens when an attempt to write to a pipe cannot proceed because the other end of the pipe has been closed. Common in IPC (Inter-Process Communication) scenarios.

UnexpectedEof - Similar to EndOfFile but specifically refers to cases where the EOF occurs unexpectedly, possibly indicating truncated or corrupted data streams.

InvalidInput - This error is raised when an input operation receives data that is not in a valid format, suggesting possible data corruption or a mismatch in expected data format.

OutOfMemory - Occurs when an operation fails due to insufficient memory available to complete the operation. This can affect data reading, buffering, or processing.

Interrupted - This error can happen if an input operation is interrupted by a system signal before it could complete, often needing a retry or causing the operation to fail.

Unsupported - Raised when an operation involves a feature or operation mode that is not supported. This might involve character encodings, data compression formats, etc.

Other - A catch-all category for errors that do not fall into the specified categories. Allows for flexible error handling of uncommon or unexpected conditions.

line : Task Str [StdinErr Err]

Read a line from standard input.

This task will block the program from continuing until stdin receives a newline character (e.g. because the user pressed Enter in the terminal), so using it can result in the appearance of the programming having gotten stuck. It's often helpful to print a prompt first, so the user knows it's necessary to enter something before the program will continue.

bytes : {} -> Task (List U8) *

Read bytes from standard input. ‼️ This function can read no more than 16,384 bytes at a time. Use readToEnd if you need more.

This is typically used in combintation with Tty.enableRawMode, which disables defaults terminal bevahiour and allows reading input without buffering until Enter key is pressed.

readToEnd : {} -> Task (List U8) [StdinErr Err]

Read all bytes from standard input until EOF in this source.