aboutsummaryrefslogtreecommitdiff
path: root/man/man3/tomo-Path.write_bytes.3
diff options
context:
space:
mode:
authorBruce Hill <bruce@bruce-hill.com>2025-04-19 14:35:34 -0400
committerBruce Hill <bruce@bruce-hill.com>2025-04-19 14:35:34 -0400
commit67fd3c725e6511adf70345f0733ec0b948477a11 (patch)
tree913d9f30d8ce3614a9ae3715281f8804323b24ff /man/man3/tomo-Path.write_bytes.3
parent0974d632c3dda7874f01c58bfc342b73cd1634a4 (diff)
Make API documentation into YAML files and autogenerate markdown files
and manpages from those.
Diffstat (limited to 'man/man3/tomo-Path.write_bytes.3')
-rw-r--r--man/man3/tomo-Path.write_bytes.335
1 files changed, 35 insertions, 0 deletions
diff --git a/man/man3/tomo-Path.write_bytes.3 b/man/man3/tomo-Path.write_bytes.3
new file mode 100644
index 00000000..6cf31725
--- /dev/null
+++ b/man/man3/tomo-Path.write_bytes.3
@@ -0,0 +1,35 @@
+'\" t
+.\" Copyright (c) 2025 Bruce Hill
+.\" All rights reserved.
+.\"
+.TH Path.write_bytes 3 2025-04-19T14:30:40.366166 "Tomo man-pages"
+.SH NAME
+Path.write_bytes \- Writes the given bytes to the file at the specified path, creating the file if it doesn't already exist. Sets the file permissions as specified. If the file writing cannot be successfully completed, a runtime error is raised.
+
+.SH LIBRARY
+Tomo Standard Library
+.SH SYNOPSIS
+.nf
+.BI "Path.write_bytes : func(path: Path, bytes: [Byte], permissions = Int32(0o644) -> Void)"
+.fi
+
+.SH DESCRIPTION
+Writes the given bytes to the file at the specified path, creating the file if it doesn't already exist. Sets the file permissions as specified. If the file writing cannot be successfully completed, a runtime error is raised.
+
+
+.TS
+allbox;
+lb lb lbx lb
+l l l l.
+Name Type Description Default
+path Path The path of the file to write to. -
+bytes [Byte] A list of bytes to write to the file. -
+permissions The permissions to set on the file if it is created. Int32(0o644)
+.TE
+.SH RETURN
+Nothing.
+
+.SH EXAMPLES
+.EX
+(./file.txt).write_bytes([104, 105])
+.EE