aboutsummaryrefslogtreecommitdiff
path: root/man/man3/tomo-Path.can_write.3
blob: d1be5006beb8adf8e5b2e7f4918fd4447a862566 (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
'\" t
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
.TH Path.can_write 3 2025-09-21 "Tomo man-pages"
.SH NAME
Path.can_write \- check write permissions
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.can_write\ :\ func(path:\ Path\ ->\ Bool)
.fi
.SH DESCRIPTION
Returns whether or not a file can be written by the current user/group.


.SH ARGUMENTS

.TS
allbox;
lb lb lbx lb
l l l l.
Name	Type	Description	Default
path	Path	The path of the file to check. 	-
.TE
.SH RETURN
`yes` if the file or directory exists and the current user has write permissions, otherwise `no`.

.SH EXAMPLES
.EX
assert (/tmp).can_write() == yes
assert (/etc/passwd).can_write() == no
assert (/non/existant/file).can_write() == no
.EE