tomo-Text.find.3

(40 lines)
   1 '\" t
   2 .\" Copyright (c) 2025 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Text.find 3 2025-11-29 "Tomo man-pages"
   6 .SH NAME
   7 Text.find \- find a substring
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Text.find\ :\ func(text:\ Text,\ target:\ Text,\ start:\ Int\ =\ 1\ ->\ Int)
  13 .fi
  14 .SH DESCRIPTION
  15 Find a substring within a text and return its index, if found.
  16 
  17 
  18 .SH ARGUMENTS
  19 
  20 .TS
  21 allbox;
  22 lb lb lbx lb
  23 l l l l.
  24 Name	Type	Description	Default
  25 text	Text	The text to be searched. 	-
  26 target	Text	The target text to find. 	-
  27 start	Int	The index at which to begin searching. 	1
  28 .TE
  29 .SH RETURN
  30 The index where the first occurrence of `target` appears, or `none` if it is not found.
  31 
  32 .SH EXAMPLES
  33 .EX
  34 assert "one two".find("one") == 1
  35 assert "one two".find("two") == 5
  36 assert "one two".find("three") == none
  37 assert "one two".find("o", start=2) == 7
  38 .EE
  39 .SH SEE ALSO
  40 .BR Tomo-Text (3)