aboutsummaryrefslogtreecommitdiff
path: root/man/man3/tomo-Byte.parse.3
diff options
context:
space:
mode:
authorBruce Hill <bruce@bruce-hill.com>2025-08-16 17:21:01 -0400
committerBruce Hill <bruce@bruce-hill.com>2025-08-16 17:21:01 -0400
commitc72b0406a32ffc3f04324f7b6c321486762fca41 (patch)
tree244e51c858890ea2ffb8c74a2c33c81b79de376e /man/man3/tomo-Byte.parse.3
parent849fd423a759edf1b58b548a6148c177a6f8cd71 (diff)
Improved parsing and prefix/suffix matching using a `remainder`
parameter
Diffstat (limited to 'man/man3/tomo-Byte.parse.3')
-rw-r--r--man/man3/tomo-Byte.parse.317
1 files changed, 13 insertions, 4 deletions
diff --git a/man/man3/tomo-Byte.parse.3 b/man/man3/tomo-Byte.parse.3
index 6e4d3bb6..1beeb3a4 100644
--- a/man/man3/tomo-Byte.parse.3
+++ b/man/man3/tomo-Byte.parse.3
@@ -2,14 +2,14 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Byte.parse 3 2025-04-30 "Tomo man-pages"
+.TH Byte.parse 3 2025-08-16 "Tomo man-pages"
.SH NAME
Byte.parse \- convert text to a byte
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
-.BI Byte.parse\ :\ func(text:\ Text\ ->\ Byte?)
+.BI Byte.parse\ :\ func(text:\ Text,\ remainder:\ &Text?\ =\ none\ ->\ Byte?)
.fi
.SH DESCRIPTION
Parse a byte literal from text.
@@ -23,6 +23,7 @@ lb lb lbx lb
l l l l.
Name Type Description Default
text Text The text to parse. -
+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
.TE
.SH RETURN
The byte parsed from the text, if successful, otherwise `none`.
@@ -30,7 +31,15 @@ The byte parsed from the text, if successful, otherwise `none`.
.SH EXAMPLES
.EX
>> Byte.parse("5")
-= Byte(5)?
+= Byte(5) : Byte?
>> Byte.parse("asdf")
-= none
+= none : Byte?
+
+>> Byte.parse("123xyz")
+= none : Byte?
+remainder : Text
+>> Byte.parse("123xyz", &remainder)
+= Byte(123) : Byte?
+>> remainder
+= "xyz"
.EE