blob: 70ef4a56ee3108efcbfe5600dd62c9de961b618d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
|
'\" t
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
.TH Path.remove 3 2025-12-07 "Tomo man-pages"
.SH NAME
Path.remove \- remove a file or directory
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.remove\ :\ func(path:\ Path,\ ignore_missing\ =\ no\ ->\ Result)
.fi
.SH DESCRIPTION
Removes the file or directory at the specified path. A runtime error is raised if something goes wrong.
.SH ARGUMENTS
.TS
allbox;
lb lb lbx lb
l l l l.
Name Type Description Default
path Path The path to remove. -
ignore_missing Whether to ignore errors if the file or directory does not exist. no
.TE
.SH RETURN
Either `Success` or `Failure(reason)`.
.SH EXAMPLES
.EX
(./file.txt).remove()
.EE
.SH SEE ALSO
.BR Tomo-Path (3)
|
