code / tomo

   1 '\" t
   2 .\" Copyright (c) 2025 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Text.split_any 3 2025-11-29 "Tomo man-pages"
   6 .SH NAME
   7 Text.split_any \- split a text by multiple delimiters
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Text.split_any\ :\ func(text:\ Text,\ delimiters:\ Text\ =\ "\ $\[rs]t\[rs]r\[rs]n"\ ->\ [Text])
  13 .fi
  14 .SH DESCRIPTION
  15 Splits the text into a list of substrings at one or more occurrences of a set of delimiter characters (grapheme clusters).
  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 split. 	-
  26 delimiters	Text	A text containing delimiters to use for splitting the text. 	"\ $\[rs]t\[rs]r\[rs]n"
  27 .TE
  28 .SH RETURN
  29 A list of subtexts resulting from the split.
  30 
  31 .SH NOTES
  32 Splitting will occur on every place where one or more of the grapheme clusters in `delimiters` occurs.
  33 To split based on an exact delimiter, use Text.split().
  34 
  35 .SH EXAMPLES
  36 .EX
  37 assert "one, two,,three".split_any(", ") == ["one", "two", "three"]
  38 .EE
  39 .SH SEE ALSO
  40 .BR Tomo-Text (3)