tomo-Path.by_line.3

(44 lines)
   1 '\" t
   2 .\" Copyright (c) 2025 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Path.by_line 3 2025-11-29 "Tomo man-pages"
   6 .SH NAME
   7 Path.by_line \- iterate by line
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Path.by_line\ :\ func(path:\ Path\ ->\ func(->Text?)?)
  13 .fi
  14 .SH DESCRIPTION
  15 Returns an iterator that can be used to iterate over a file one line at a time, or returns none if the file could not be opened.
  16 
  17 
  18 .SH ARGUMENTS
  19 
  20 .TS
  21 allbox;
  22 lb lb lbx
  23 l l l.
  24 Name	Type	Description
  25 path	Path	The path of the file. 
  26 .TE
  27 .SH RETURN
  28 An iterator that can be used to get lines from a file one at a time or none if the file couldn't be read.
  29 
  30 .SH EXAMPLES
  31 .EX
  32 # Safely handle file not being readable:
  33 if lines := (./file.txt).by_line()
  34     for line in lines
  35         say(line.upper())
  36 else
  37     say("Couldn't read file!")
  38 
  39 # Assume the file is readable and error if that's not the case:
  40 for line in (/dev/stdin).by_line()!
  41     say(line.upper())
  42 .EE
  43 .SH SEE ALSO
  44 .BR Tomo-Path (3)