File

File :: # (opaque)

Open files for incremental, buffered reading.

Whole-file operations and filesystem metadata are available on Path.

open_reader! : Path => Try(
    Reader,
    [
        PathErr(
            IOErr,
            Path,
        ),
    ],
)

Open a file for buffered reading using the default buffer capacity.

Failing to open reports the path, using the same PathErr as the whole-file operations so both combine in one error type.

reader = File.open_reader!("LICENSE")?
line = reader.read_line!()?

open_reader_with_capacity! : Path, U64 => Try(
    Reader,
    [
        PathErr(
            IOErr,
            Path,
        ),
    ],
)

Open a file for buffered reading using a specific buffer capacity.

Reader

File.Reader :: # (opaque)

Represents a buffered file reader.

The file is automatically closed when the last reference to the reader is dropped. It wraps an opaque host-side BufReader<File> handle.

to_inspect : Reader -> Str

Render the reader without exposing its host handle.

read_line! : Reader => Try(List(U8), _)

Read bytes up to and including the next newline from this buffered reader.

Returns an empty list at EOF.