'\" t
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
.TH Text.slice 3 2025-11-29 "Tomo man-pages"
.SH NAME
Text.slice \- get a slice of a text
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.slice\ :\ func(text:\ Text,\ from:\ Int\ =\ 1,\ to:\ Int\ =\ -1\ ->\ Text)
.fi
.SH DESCRIPTION
Get a slice of the text.


.SH ARGUMENTS

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

.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".slice(2, 3) == "el"
assert "hello".slice(to=-2) == "hell"
assert "hello".slice(from=2) == "ello"
.EE
.SH SEE ALSO
.BR Tomo-Text (3)