aboutsummaryrefslogtreecommitdiff
path: root/man/man3/tomo-Path.is_socket.3
blob: f54df228eea4308a5e846348e313d60a620b00bb (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.is_socket 3 2025-04-21 "Tomo man-pages"
.SH NAME
Path.is_socket \- check if a path is a socket
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.is_socket\ :\ func(path:\ Path,\ follow_symlinks\ =\ yes\ ->\ Bool)
.fi
.SH DESCRIPTION
Checks if the path represents a socket. Optionally follows symbolic links.


.SH ARGUMENTS

.TS
allbox;
lb lb lbx lb
l l l l.
Name	Type	Description	Default
path	Path	The path to check. 	-
follow_symlinks		Whether to follow symbolic links. 	yes
.TE
.SH RETURN
`True` if the path is a socket, `False` otherwise.

.SH EXAMPLES
.EX
>> (./socket).is_socket()
= yes
.EE