code / tomo

   1 '\" t
   2 .\" Copyright (c) 2026 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Path.read_bytes 3 2026-03-08 "Tomo man-pages"
   6 .SH NAME
   7 Path.read_bytes \- read file contents as bytes
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Path.read_bytes\ :\ func(path:\ Path,\ limit:\ Int?\ =\ none\ ->\ [Byte]?)
  13 .fi
  14 .SH DESCRIPTION
  15 Reads the contents of the file at the specified path or none if the file could not be read.
  16 
  17 
  18 .SH ARGUMENTS
  19 
  20 .TS
  21 allbox;
  22 lb lb lbx lb
  23 l l l l.
  24 Name	Type	Description	Default
  25 path	Path	The path of the file to read. 	-
  26 limit	Int?	A limit to how many bytes should be read. 	none
  27 .TE
  28 .SH RETURN
  29 The byte contents of the file. If the file cannot be read, none will be returned.
  30 
  31 .SH EXAMPLES
  32 .EX
  33 assert (./hello.txt).read_bytes()! == [72, 101, 108, 108, 111]
  34 assert (./nosuchfile.xxx).read_bytes() == none
  35 .EE
  36 .SH SEE ALSO
  37 .BR Tomo-Path (3)