tomo-Text.to.3

(40 lines)
   1 '\" t
   2 .\" Copyright (c) 2025 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Text.to 3 2025-11-29 "Tomo man-pages"
   6 .SH NAME
   7 Text.to \- slice to an end index
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Text.to\ :\ func(text:\ Text,\ last:\ Int\ ->\ Text)
  13 .fi
  14 .SH DESCRIPTION
  15 Get a slice of the text, ending at the given position.
  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 to be sliced. 
  26 last	Int	The index of the last grapheme cluster to include (1-indexed). 
  27 .TE
  28 .SH RETURN
  29 The text up to and including the given grapheme cluster.
  30 
  31 .SH NOTES
  32 A negative index counts backwards from the end of the text, so `-1` refers to the last cluster, `-2` the second-to-last, etc. Slice ranges will be truncated to the length of the text.
  33 
  34 .SH EXAMPLES
  35 .EX
  36 assert "goodbye".to(3) == "goo"
  37 assert "goodbye".to(-2) == "goodby"
  38 .EE
  39 .SH SEE ALSO
  40 .BR Tomo-Text (3)