tomo-Text.at.3

(39 lines)
   1 '\" t
   2 .\" Copyright (c) 2025 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Text.at 3 2025-11-29 "Tomo man-pages"
   6 .SH NAME
   7 Text.at \- get a letter
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Text.at\ :\ func(text:\ Text,\ index:\ Int\ ->\ Text)
  13 .fi
  14 .SH DESCRIPTION
  15 Get the graphical cluster at a given index. This is similar to `str[i]` with ASCII text, but has more correct behavior for unicode text.
  16 
  17 
  18 .SH ARGUMENTS
  19 
  20 .TS
  21 allbox;
  22 lb lb lbx
  23 l l l.
  24 Name	Type	Description
  25 text	Text	The text from which to get a cluster. 
  26 index	Int	The index of the graphical cluster (1-indexed). 
  27 .TE
  28 .SH RETURN
  29 A `Text` with the single graphical cluster at the given index.
  30 
  31 .SH NOTES
  32 Negative indices are counted from the back of the text, so `-1` means the last cluster, `-2` means the second-to-last, and so on.
  33 
  34 .SH EXAMPLES
  35 .EX
  36 assert "Amélie".at(3) == "é"
  37 .EE
  38 .SH SEE ALSO
  39 .BR Tomo-Text (3)