Skip to content

Readers are fallible

Level: 201 · working knowledge

One line: A read is a request to something outside your program, so it can fail after the file opened fine — which is why BufRead::lines() ↗ hands you an io::Result<String> per line rather than a String.

Stub — an outline, not a lesson. There is no runnable example behind this page yet, so nothing on it has been through the check that backs every other claim in this library. The bullets below are the questions the finished page has to answer.

What it has to cover

  • Why the Result is per line, not per file: opening succeeded, and the failure is somewhere in the middle
  • What can actually go wrong that late — a disk or network read error, a pipe whose other end closed, and bytes that are not UTF-8 (ErrorKind::InvalidData)
  • The three shapes of the loop, and what each one decides: for line in reader.lines() with let line = line?; inside, .map_while(Result::ok), and collect::<io::Result<Vec<String>>>()
  • What lines() does to the trailing newline — a separate question from failure, and the one that actually bites first
  • Reading from standard input rather than a file: io::stdin().lock(), and why the same Result shows up there

The trap it exists for

.flatten() and .filter_map(Result::ok) both make the type error go away, and both convert "the disk failed halfway through" into "the file was shorter than it is." The program then prints a smaller number with total confidence. A count that silently drops rows is worse than a count that stops, because nothing about the output says anything went wrong.

See also

Po polsku

To, że plik otworzył się poprawnie, wcale nie znaczy, że da się go doczytać do końca — dlatego lines() zwraca io::Result<String> osobno dla każdej linii, a nie jeden wynik na cały plik. Polskiego czytelnika spotyka przy tym przyczyna, której anglojęzyczny kolega może nie zobaczyć nigdy: plik zapisany w windows-1250 albo ISO-8859-2, z jednym „ż” czy „ł”, nie jest poprawnym UTF-8, więc odczyt przewraca się na ErrorKind::InvalidData w środku skądinąd zdrowego pliku. I tu czai się pułapka tej strony — .flatten() oraz .filter_map(Result::ok) usuwają błąd kompilacji, ale robią to, zamieniając „dysk padł w połowie” na „plik był krótszy, niż jest”, a program wypisuje mniejszą liczbę z pełnym przekonaniem. Zliczanie, które po cichu gubi wiersze, jest gorsze od takiego, które się zatrzymuje, bo w samym wyniku nie zostaje żaden ślad po tym, że coś poszło źle.

Szukaj po polsku: kodowanie ISO-8859-2 a UTF-8 · odczyt pliku linia po linii · rust BufRead lines io::Result · rust ErrorKind::InvalidData · rust flatten hides errors