tomo-Byte.3

(51 lines)
   1 '\" t
   2 .\" Copyright (c) 2026 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Byte 3 2026-03-08 "Tomo man-pages"
   6 .SH NAME
   7 Byte \- a Tomo type
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .fi
  11 .SH METHODS
  12 
  13 .TP
  14 .BI Byte.get_bit\ :\ func(i:\ Byte,\ bit_index:\ Int\ ->\ Bool)
  15 In the binary representation of a byte, check whether a given bit index is set to 1 or not. 
  16 
  17 For more, see:
  18 .BR Tomo-Byte.get_bit (3)
  19 
  20 
  21 .TP
  22 .BI Byte.hex\ :\ func(byte:\ Byte,\ uppercase:\ Bool\ =\ yes,\ prefix:\ Bool\ =\ no\ ->\ Text)
  23 Convert a byte to a hexidecimal text representation. 
  24 
  25 For more, see:
  26 .BR Tomo-Byte.hex (3)
  27 
  28 
  29 .TP
  30 .BI Byte.is_between\ :\ func(x:\ Byte,\ low:\ Byte,\ high:\ Byte\ ->\ Bool)
  31 Determines if an integer is between two numbers (inclusive). 
  32 
  33 For more, see:
  34 .BR Tomo-Byte.is_between (3)
  35 
  36 
  37 .TP
  38 .BI Byte.parse\ :\ func(text:\ Text,\ base:\ Int?\ =\ none,\ remainder:\ &Text?\ =\ none\ ->\ Byte?)
  39 Parse a byte literal from text. 
  40 
  41 For more, see:
  42 .BR Tomo-Byte.parse (3)
  43 
  44 
  45 .TP
  46 .BI Byte.to\ :\ func(first:\ Byte,\ last:\ Byte,\ step:\ Int8?\ =\ none\ ->\ func(->Byte?))
  47 Returns an iterator function that iterates over the range of bytes specified. 
  48 
  49 For more, see:
  50 .BR Tomo-Byte.to (3)
  51