aboutsummaryrefslogtreecommitdiff
path: root/man/man3/tomo-Text.from.3
blob: 53df827872f5eee36fab06d87256c344b7f7725e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
'\" t
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
.TH Text.from 3 2025-11-29 "Tomo man-pages"
.SH NAME
Text.from \- slice from a starting index
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.from\ :\ func(text:\ Text,\ first:\ Int\ ->\ Text)
.fi
.SH DESCRIPTION
Get a slice of the text, starting at the given position.


.SH ARGUMENTS

.TS
allbox;
lb lb lbx
l l l.
Name	Type	Description
text	Text	The text to be sliced. 
first	Int	The index to begin the slice. 
.TE
.SH RETURN
The text from the given grapheme cluster to the end of the text.

.SH NOTES
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.

.SH EXAMPLES
.EX
assert "hello".from(2) == "ello"
assert "hello".from(-2) == "lo"
.EE
.SH SEE ALSO
.BR Tomo-Text (3)