code / tomo

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