tomo-Text.from.3

(40 lines)
   1 '\" t
   2 .\" Copyright (c) 2025 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Text.from 3 2025-11-29 "Tomo man-pages"
   6 .SH NAME
   7 Text.from \- slice from a starting index
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Text.from\ :\ func(text:\ Text,\ first:\ Int\ ->\ Text)
  13 .fi
  14 .SH DESCRIPTION
  15 Get a slice of the text, starting 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 first	Int	The index to begin the slice. 
  27 .TE
  28 .SH RETURN
  29 The text from the given grapheme cluster to the end of the text.
  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 "hello".from(2) == "ello"
  37 assert "hello".from(-2) == "lo"
  38 .EE
  39 .SH SEE ALSO
  40 .BR Tomo-Text (3)