tomo-Text.starts_with.3

(40 lines)
   1 '\" t
   2 .\" Copyright (c) 2025 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Text.starts_with 3 2025-11-29 "Tomo man-pages"
   6 .SH NAME
   7 Text.starts_with \- check prefix
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Text.starts_with\ :\ func(text:\ Text,\ prefix:\ Text,\ remainder:\ &Text?\ =\ none\ ->\ Bool)
  13 .fi
  14 .SH DESCRIPTION
  15 Checks if the `Text` starts with a literal prefix text.
  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 prefix	Text	The literal prefix text to check for. 	-
  27 remainder	&Text?	If non-none, this value will be set to the rest of the text after the prefix. If the prefix is not found, this value will be set to the original text. 	none
  28 .TE
  29 .SH RETURN
  30 `yes` if the text has the given prefix, `no` otherwise.
  31 
  32 .SH EXAMPLES
  33 .EX
  34 assert "hello world".starts_with("hello") == yes
  35 remainder : Text
  36 assert "hello world".starts_with("hello", &remainder) == yes
  37 assert remainder == " world"
  38 .EE
  39 .SH SEE ALSO
  40 .BR Tomo-Text (3)