blob: a23cbf6db5165570ff2e62ebdaf35eba3390b03b (
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
|
'\" t
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
.TH Path.read_bytes 3 2025-09-21 "Tomo man-pages"
.SH NAME
Path.read_bytes \- read file contents as bytes
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Path.read_bytes\ :\ func(path:\ Path,\ limit:\ Int?\ =\ none\ ->\ [Byte]?)
.fi
.SH DESCRIPTION
Reads the contents of the file at the specified path or none if the file could not be read.
.SH ARGUMENTS
.TS
allbox;
lb lb lbx lb
l l l l.
Name Type Description Default
path Path The path of the file to read. -
limit Int? A limit to how many bytes should be read. none
.TE
.SH RETURN
The byte contents of the file. If the file cannot be read, none will be returned.
.SH EXAMPLES
.EX
assert (./hello.txt).read() == [72, 101, 108, 108, 111]
assert (./nosuchfile.xxx).read() == none
.EE
|
