aboutsummaryrefslogtreecommitdiff
path: root/man/man3/tomo-Text.to.3
blob: 0f9662f93bf2684c7ba2e08b275d4ab06c30582d (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
41
'\" t
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
.TH Text.to 3 2025-04-21T14:54:02.051563 "Tomo man-pages"
.SH NAME
Text.to \- slice to an end index
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.to\ :\ func(text:\ Text,\ last:\ Int\ ->\ Text)
.fi
.SH DESCRIPTION
Get a slice of the text, ending at the given position.


.SH ARGUMENTS

.TS
allbox;
lb lb lbx lb
l l l l.
Name	Type	Description	Default
text	Text	The text to be sliced. 	-
last	Int	The index of the last grapheme cluster to include (1-indexed). 	-
.TE
.SH RETURN
The text up to and including the given grapheme cluster.

.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
>> "goodbye".to(3)
= "goo"

>> "goodbye".to(-2)
= "goodby"
.EE