tomo-Path.extension.3

(39 lines)
   1 '\" t
   2 .\" Copyright (c) 2025 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Path.extension 3 2025-11-29 "Tomo man-pages"
   6 .SH NAME
   7 Path.extension \- get file extension
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Path.extension\ :\ func(path:\ Path,\ full:\ Bool\ =\ yes\ ->\ Text)
  13 .fi
  14 .SH DESCRIPTION
  15 Returns the file extension of the file at the specified path. Optionally returns the full extension.
  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 of the file. 	-
  26 full	Bool	Whether to return everything after the first \fB.\fR in the base name, or only the last part of the extension. 	yes
  27 .TE
  28 .SH RETURN
  29 The file extension (not including the leading `.`) or an empty text if there is no file extension.
  30 
  31 .SH EXAMPLES
  32 .EX
  33 assert (./file.tar.gz).extension() == "tar.gz"
  34 assert (./file.tar.gz).extension(full=no) == "gz"
  35 assert (/foo).extension() == ""
  36 assert (./.git).extension() == ""
  37 .EE
  38 .SH SEE ALSO
  39 .BR Tomo-Path (3)