tomo-Bool.parse.3

(43 lines)
   1 '\" t
   2 .\" Copyright (c) 2025 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Bool.parse 3 2025-11-29 "Tomo man-pages"
   6 .SH NAME
   7 Bool.parse \- parse into boolean
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Bool.parse\ :\ func(text:\ Text,\ remainder:\ &Text?\ =\ none\ ->\ Bool?)
  13 .fi
  14 .SH DESCRIPTION
  15 Converts a text representation of a boolean value into a boolean. Acceptable boolean values are case-insensitive variations of `yes`/`no`, `y`/`n`, `true`/`false`, `on`/`off`.
  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 string containing the boolean value. 	-
  26 remainder	&Text?	If non-none, this argument will be set to the remainder of the text after the matching part. If none, parsing will only succeed if the entire text matches. 	none
  27 .TE
  28 .SH RETURN
  29 `yes` if the string matches a recognized truthy boolean value; otherwise return `no`.
  30 
  31 .SH EXAMPLES
  32 .EX
  33 assert Bool.parse("yes") == yes
  34 assert Bool.parse("no") == no
  35 assert Bool.parse("???") == none
  36 
  37 assert Bool.parse("yesJUNK") == none
  38 remainder : Text
  39 assert Bool.parse("yesJUNK", &remainder) == yes
  40 assert remainder == "JUNK"
  41 .EE
  42 .SH SEE ALSO
  43 .BR Tomo-Bool (3)