tomo-Path.remove.3

(36 lines)
   1 '\" t
   2 .\" Copyright (c) 2026 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Path.remove 3 2026-03-08 "Tomo man-pages"
   6 .SH NAME
   7 Path.remove \- remove a file or directory
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Path.remove\ :\ func(path:\ Path,\ ignore_missing\ =\ no\ ->\ Result)
  13 .fi
  14 .SH DESCRIPTION
  15 Removes the file or directory at the specified path. A runtime error is raised if something goes wrong.
  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 to remove. 	-
  26 ignore_missing		Whether to ignore errors if the file or directory does not exist. 	no
  27 .TE
  28 .SH RETURN
  29 Either `Success` or `Failure(reason)`.
  30 
  31 .SH EXAMPLES
  32 .EX
  33 (./file.txt).remove()!
  34 .EE
  35 .SH SEE ALSO
  36 .BR Tomo-Path (3)