tomo-Path.can_read.3

(37 lines)
   1 '\" t
   2 .\" Copyright (c) 2025 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Path.can_read 3 2025-11-29 "Tomo man-pages"
   6 .SH NAME
   7 Path.can_read \- check read permissions
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Path.can_read\ :\ func(path:\ Path\ ->\ Bool)
  13 .fi
  14 .SH DESCRIPTION
  15 Returns whether or not a file can be read by the current user/group.
  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 check. 
  26 .TE
  27 .SH RETURN
  28 `yes` if the file or directory exists and the current user has read permissions, otherwise `no`.
  29 
  30 .SH EXAMPLES
  31 .EX
  32 assert (/usr/include/stdlib.h).can_read() == yes
  33 assert (/etc/shadow).can_read() == no
  34 assert (/non/existant/file).can_read() == no
  35 .EE
  36 .SH SEE ALSO
  37 .BR Tomo-Path (3)