1234567891011121314151617181920212223242526272829303132333435363738 | '\" t
.\" Copyright (c) 2026 Bruce Hill
.\" All rights reserved.
.\"
.TH Path.base_name 3 2026-09-01 "Tomo man-pages"
.SH NAME
Path.base_name \- base name of a file
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.base_name\ :\ func(path:\ Path\ ->\ Text?)
.fi
.SH DESCRIPTION
Returns the base name of the file or directory at the specified path.
.SH ARGUMENTS
.TS
allbox;
lb lb lbx
l l l.
Name Type Description
path Path The path of the file or directory.
.TE
.SH RETURN
The base name of the file or directory, or `none` if it is not valid UTF-8.
.SH ERRORS
A POSIX filename is an arbitrary sequence of bytes, but `Text` holds Unicode, so this returns `none` when the name is not valid UTF-8.
.SH EXAMPLES
.EX
assert (./path/to/file.txt).base_name() == "file.txt"
.EE
.SH SEE ALSO
.BR Tomo-Path (3)
|