tomo-Path.write.3

(37 lines)
   1 '\" t
   2 .\" Copyright (c) 2026 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Path.write 3 2026-03-08 "Tomo man-pages"
   6 .SH NAME
   7 Path.write \- write to a file
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Path.write\ :\ func(path:\ Path,\ text:\ Text,\ permissions\ =\ Int32(0o644)\ ->\ Result)
  13 .fi
  14 .SH DESCRIPTION
  15 Writes the given text to the file at the specified path, creating the file if it doesn't already exist. Sets the file permissions as specified. If the file writing cannot be successfully completed, a runtime error is raised.
  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 file to write to. 	-
  26 text	Text	The text to write to the file. 	-
  27 permissions		The permissions to set on the file if it is created. 	Int32(0o644)
  28 .TE
  29 .SH RETURN
  30 Either `Success` or `Failure(reason)`.
  31 
  32 .SH EXAMPLES
  33 .EX
  34 (./file.txt).write("Hello, world!")!
  35 .EE
  36 .SH SEE ALSO
  37 .BR Tomo-Path (3)