code / tomo

   1 '\" t
   2 .\" Copyright (c) 2025 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Path.is_symlink 3 2025-11-29 "Tomo man-pages"
   6 .SH NAME
   7 Path.is_symlink \- check if a path is a symbolic link
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Path.is_symlink\ :\ func(path:\ Path\ ->\ Bool)
  13 .fi
  14 .SH DESCRIPTION
  15 Checks if the path represents a symbolic link.
  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 to check. 
  26 .TE
  27 .SH RETURN
  28 `True` if the path is a symbolic link, `False` otherwise.
  29 
  30 .SH EXAMPLES
  31 .EX
  32 assert (./link).is_symlink() == yes
  33 .EE
  34 .SH SEE ALSO
  35 .BR Tomo-Path (3)