aboutsummaryrefslogtreecommitdiff
path: root/man/man3/tomo-Path.write_unique_bytes.3
diff options
context:
space:
mode:
Diffstat (limited to 'man/man3/tomo-Path.write_unique_bytes.3')
-rw-r--r--man/man3/tomo-Path.write_unique_bytes.338
1 files changed, 38 insertions, 0 deletions
diff --git a/man/man3/tomo-Path.write_unique_bytes.3 b/man/man3/tomo-Path.write_unique_bytes.3
new file mode 100644
index 00000000..0aae419f
--- /dev/null
+++ b/man/man3/tomo-Path.write_unique_bytes.3
@@ -0,0 +1,38 @@
+'\" t
+.\" Copyright (c) 2025 Bruce Hill
+.\" All rights reserved.
+.\"
+.TH Path.write_unique_bytes 3 2025-04-19T14:30:40.366241 "Tomo man-pages"
+.SH NAME
+Path.write_unique_bytes \- Writes the given bytes 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 LIBRARY
+Tomo Standard Library
+.SH SYNOPSIS
+.nf
+.BI "Path.write_unique_bytes : func(path: Path, bytes: [Byte] -> Path)"
+.fi
+
+.SH DESCRIPTION
+Writes the given bytes 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.
+
+
+.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. -
+bytes [Byte] The bytes 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_bytes([1, 2, 3])
+= (./file-27QHtq.txt)
+>> created.read()
+= [1, 2, 3]
+created.remove()
+.EE