code / tomo

   1 '\" t
   2 .\" Copyright (c) 2026 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Path.each_child 3 2026-03-14 "Tomo man-pages"
   6 .SH NAME
   7 Path.each_child \- iterate over children of a directory
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Path.each_child\ :\ func(path:\ Path,\ include_hidden\ =\ no\ ->\ func(->Path?)?)
  13 .fi
  14 .SH DESCRIPTION
  15 Returns an iterator over the children (files and directories) within the directory at the specified path. Optionally includes hidden files. Iteration order is not specified.
  16 
  17 
  18 .SH ARGUMENTS
  19 
  20 .TS
  21 allbox;
  22 lb lb lbx lb
  23 l l l l.
  24 Name	Type	Description	Default
  25 path	Path	The path of the directory. 	-
  26 include_hidden		Whether to include hidden files (those starting with a \fB.\fR). 	no
  27 .TE
  28 .SH RETURN
  29 An iterator over the children in a directory or `none` if the path is not a directory or a symlink to a directory.
  30 
  31 .SH EXAMPLES
  32 .EX
  33 for child in (/dir).each_child()
  34     say("Child: $child")
  35 .EE
  36 .SH SEE ALSO
  37 .BR Tomo-Path (3)