aboutsummaryrefslogtreecommitdiff
path: root/man/man3/tomo-Path.write_unique.3
blob: 002e851cd032f89986b3947403ec3cadc7739326 (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
36
37
38
'\" t
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
.TH Path.write_unique 3 2025-04-21 "Tomo man-pages"
.SH NAME
Path.write_unique \- write to a uniquely named file
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.write_unique\ :\ func(path:\ Path,\ text:\ Text\ ->\ Path)
.fi
.SH DESCRIPTION
Writes the given text to a unique file path based on the specified path. The file is created if it doesn't exist. This is useful for creating temporary files.


.SH ARGUMENTS

.TS
allbox;
lb lb lbx lb
l l l l.
Name	Type	Description	Default
path	Path	The base path for generating the unique file. This path must include the string `XXXXXX` in the file base name. 	-
text	Text	The text to write to the file. 	-
.TE
.SH RETURN
The path of the newly created unique file.

.SH EXAMPLES
.EX
>> created := (./file-XXXXXX.txt).write_unique("Hello, world!")
= (./file-27QHtq.txt)
>> created.read()
= "Hello, world!"
created.remove()
.EE