code / tomo

   1 '\" t
   2 .\" Copyright (c) 2026 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Path.unique_directory 3 2026-03-08 "Tomo man-pages"
   6 .SH NAME
   7 Path.unique_directory \- create a directory with a unique name
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Path.unique_directory\ :\ func(path:\ Path\ ->\ Path)
  13 .fi
  14 .SH DESCRIPTION
  15 Generates a unique directory path based on the given path. Useful for creating temporary directories.
  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 base path for generating the unique directory. The last six letters of this path must be \fBXXXXXX\fR. 
  26 .TE
  27 .SH RETURN
  28 A unique directory path after creating the directory.
  29 
  30 .SH EXAMPLES
  31 .EX
  32 created := (/tmp/my-dir.XXXXXX).unique_directory()
  33 assert created.is_directory() == yes
  34 created.remove()!
  35 .EE
  36 .SH SEE ALSO
  37 .BR Tomo-Path (3)