tomo-Byte.hex.3

(37 lines)
   1 '\" t
   2 .\" Copyright (c) 2026 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Byte.hex 3 2026-03-08 "Tomo man-pages"
   6 .SH NAME
   7 Byte.hex \- convert to hexidecimal
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Byte.hex\ :\ func(byte:\ Byte,\ uppercase:\ Bool\ =\ yes,\ prefix:\ Bool\ =\ no\ ->\ Text)
  13 .fi
  14 .SH DESCRIPTION
  15 Convert a byte to a hexidecimal text representation.
  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 byte	Byte	The byte to convert to hex. 	-
  26 uppercase	Bool	Whether or not to use uppercase hexidecimal letters. 	yes
  27 prefix	Bool	Whether or not to prepend a \fB0x\fR prefix. 	no
  28 .TE
  29 .SH RETURN
  30 The byte as a hexidecimal text.
  31 
  32 .SH EXAMPLES
  33 .EX
  34 assert Byte(18).hex(prefix=yes) == "0x12"
  35 .EE
  36 .SH SEE ALSO
  37 .BR Tomo-Byte (3)