code / tomo

   1 '\" t
   2 .\" Copyright (c) 2026 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Text.by_split 3 2026-03-08 "Tomo man-pages"
   6 .SH NAME
   7 Text.by_split \- iterate by a spliting text
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Text.by_split\ :\ func(text:\ Text,\ delimiter:\ Text\ =\ ""\ ->\ func(->Text?))
  13 .fi
  14 .SH DESCRIPTION
  15 Returns an iterator function that can be used to iterate over text separated by a delimiter.
  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 iterated over in delimited chunks. 	-
  26 delimiter	Text	An exact delimiter to use for splitting the text. 	""
  27 .TE
  28 .SH RETURN
  29 An iterator function that returns one chunk of text at a time, separated by the given delimiter, until it runs out and returns `none`.
  30 
  31 .SH NOTES
  32 To split based on a set of delimiters, use Text.by_split_any().
  33 If an empty text is given as the delimiter, then each split will be the graphical clusters of the text.
  34 
  35 .SH EXAMPLES
  36 .EX
  37 text := "one,two,three"
  38 chunks := [chunk for chunk in text.by_split(",")]
  39 assert chunks == ["one", "two", "three"]
  40 .EE
  41 .SH SEE ALSO
  42 .BR Tomo-Text (3)