tomo-Path.read.3

(36 lines)
   1 '\" t
   2 .\" Copyright (c) 2025 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Path.read 3 2025-11-29 "Tomo man-pages"
   6 .SH NAME
   7 Path.read \- read file contents
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Path.read\ :\ func(path:\ Path\ ->\ Text?)
  13 .fi
  14 .SH DESCRIPTION
  15 Reads the contents of the file at the specified path or none if the file could not be read.
  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 to read. 
  26 .TE
  27 .SH RETURN
  28 The contents of the file. If the file could not be read, none will be returned. If the file can be read, but is not valid UTF8 data, an error will be raised.
  29 
  30 .SH EXAMPLES
  31 .EX
  32 assert (./hello.txt).read() == "Hello"
  33 assert (./nosuchfile.xxx).read() == none
  34 .EE
  35 .SH SEE ALSO
  36 .BR Tomo-Path (3)