code / tomo

   1 '\" t
   2 .\" Copyright (c) 2025 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Text.from_utf8 3 2025-11-29 "Tomo man-pages"
   6 .SH NAME
   7 Text.from_utf8 \- convert UTF8 byte list to text
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Text.from_utf8\ :\ func(bytes:\ [Byte]\ ->\ [Text])
  13 .fi
  14 .SH DESCRIPTION
  15 Returns text that has been constructed from the given UTF8 bytes.
  16 
  17 
  18 .SH ARGUMENTS
  19 
  20 .TS
  21 allbox;
  22 lb lb lbx
  23 l l l.
  24 Name	Type	Description
  25 bytes	[Byte]	The UTF-8 bytes of the desired text. 
  26 .TE
  27 .SH RETURN
  28 A new text based on the input UTF8 bytes after normalization has been applied.
  29 
  30 .SH NOTES
  31 The text will be normalized, so the resulting text's UTF8 bytes may not exactly match the input.
  32 
  33 .SH EXAMPLES
  34 .EX
  35 assert Text.from_utf8([195, 133, 107, 101]) == "Åke"
  36 .EE
  37 .SH SEE ALSO
  38 .BR Tomo-Text (3)