Function std.stdio.File.byLine

The element type for the range will be Char[]. Range primitives may throw StdioException on I/O error.

Prototypes

auto byLine(Terminator, Char)(
  KeepTerminator keepTerminator = KeepTerminator.no,
  Terminator terminator = '\x0a'
)
if (isScalarType!Terminator);

auto byLine(Terminator, Char)(
  KeepTerminator keepTerminator,
  Terminator terminator
)
if (is(Unqual!(ElementEncodingType!Terminator) == Char));

Note

Each front will not persist after popFront is called, so the caller must copy its contents (e.g. by calling to!string) when retention is needed. If the caller needs to retain a copy of every line, use the byLineCopy function instead.

Parameters

Example

import std.algorithm, std.stdio, std.string;
// Count words in a file using ranges.
void main()
{
    auto file = File("file.txt"); // Open for reading
    const wordCount = file.byLine()            // Read lines
                          .map!split           // Split into words
                          .map!(a => a.length) // Count words per line
                          .sum();              // Total word count
    writeln(wordCount);
}

Example

import std.range, std.stdio;
// Read lines using foreach.
void main()
{
    auto file = File("file.txt"); // Open for reading
    auto range = file.byLine();
    // Print first three lines
    foreach (line; range.take(3))
        writeln(line);
    // Print remaining lines beginning with '#'
    foreach (line; range)
    {
        if (!line.empty && line[0] == '#')
            writeln(line);
    }
}

Notice that neither example accesses the line data returned by front after the corresponding popFront call is made (because the contents may well have changed).