v1.0.3

FIXED: * Link in README * ReadConnResponse was not properly reading in the response status byte before checking the checksum, leading to receiving/parsing Response messages from a net.Conn *always* failing with an errs.ErrBadHdr. This has been rectified.
fix readme link to module
2025-09-30 14:15:00 -04:00 · 2025-09-24 17:00:17 -04:00 · 2025-08-28 01:26:04 -04:00 · 2024-07-10 00:40:12 -04:00
14 changed files with 137 additions and 38 deletions
--- a/.githooks/pre-commit/01-docgen
+++ b/.githooks/pre-commit/01-docgen
@@ -15,5 +15,10 @@ for f in $(find . -maxdepth 1 -type f -iname "*.adoc"); do

 	asciidoctor -o "${docsdir}/${nosuffix}.html" "${f}"
 	git add "${docsdir}/${nosuffix}.html"
+	if command -v pandoc &> /dev/null;
+	then
+		asciidoctor -b docbook -o - "${f}" | pandoc -f docbook -t markdown_strict -o "${docsdir}/${nosuffix}.md"
+		git add "${docsdir}/${nosuffix}.md"
+	fi
 done
 echo "Regenerated docs"
--- a/README.adoc
+++ b/README.adoc
@@ -23,12 +23,12 @@ Last rendered {localdatetime}

 [id="ref"]
 == Reference
-In addition to the documentation found in this document and https://wireproto.io/[the specification^], library usage documentation can be found at https://pkg.go.dev/go.pkg.dev/r00t2.io/WireProto[the Golang module documentation page^]:
+In addition to the documentation found in this document and https://wireproto.io/[the specification^], library usage documentation can be found at https://pkg.go.dev/r00t2.io/wireproto[the Golang module documentation page^]:

 ++++
-<a href="https://pkg.go.dev/go.pkg.dev/r00t2.io/wireproto">
-    <img src="https://pkg.go.dev/badge/go.pkg.dev/r00t2.io/wireproto.svg"
-         alt="Go Reference">
+<a href="https://go.pkg.dev/r00t2.io/wireproto">
+    <img src="https://pkg.go.dev/badge/r00t2.io/wireproto.svg"
+         alt="Go Reference"/>
 </a>
 ++++

@@ -52,8 +52,11 @@ The following are a wishlist or things planned that may come in later versions.
 * More clear errors
 ** Currently during e.g. `UnmarshalBinary` calls, just an `io.EOF` will be returned if the buffer is exhausted early. This may be able to be a little more context-helpful by using the `Err*` errors.
 * Confirmation of read/write sizes in buffers
-** We know the sizes they *should* be, there's no reason to not confirm it.
+** The sizes they *should* be are known, there's no reason to not confirm it.
 * Goroutines
 ** This of course won't work for serializing and keeping *order* of children (e.g. RG => Record); that'd still need to be ordered, but it will allow for parallel parsing *of* those children. Should benchmark, though; it may not be worth it.
 * `context.Context` support for `Read*` and `Write*` funcs
 ** This is a relatively low priority as the passed `net.Conn` will likely return an error if its own context is canceled. This can be handled in the caller downstream.
+* `.Append*()` methods to append any type to any parent type. e.g. `<Response>.AppendFVP(<FieldValuePair>)` would append an FVP to the most recent ResponseRecord to the most recent ResponseRecordGroup (or create if they don't exist), `<Response>.AppendRecord(...)` for appending a record to most recent record group etc.
+* Better/more strict interfaces
+* Maps should be `any`, not `interface{}` values
--- a/README.html
+++ b/README.html
@@ -476,6 +476,10 @@ pre.rouge .gi {
  color: #116329;
  background-color: #dafbe1;
 }
+pre.rouge .ges {
+  font-weight: bold;
+  font-style: italic;
+}
 pre.rouge .kc {
  color: #0550ae;
 }
@@ -555,7 +559,7 @@ pre.rouge .gs {
 <div class="details">
 <span id="author" class="author">Brent Saner</span><br>
 <span id="email" class="email"><a href="mailto:bts@square-r00t.net">bts@square-r00t.net</a></span><br>
-<span id="revdate">Last rendered 2024-07-10 00:18:53 -0400</span>
+<span id="revdate">Last rendered 2025-09-30 14:15:01 -0400</span>
 </div>
 <div id="toc" class="toc2">
 <div id="toctitle">Table of Contents</div>
@@ -571,11 +575,11 @@ pre.rouge .gs {
 <h2 id="ref"><a class="link" href="#ref">1. Reference</a></h2>
 <div class="sectionbody">
 <div class="paragraph">
-<p>In addition to the documentation found in this document and <a href="https://wireproto.io/" target="_blank" rel="noopener">the specification</a>, library usage documentation can be found at <a href="https://pkg.go.dev/go.pkg.dev/r00t2.io/WireProto" target="_blank" rel="noopener">the Golang module documentation page</a>:</p>
+<p>In addition to the documentation found in this document and <a href="https://wireproto.io/" target="_blank" rel="noopener">the specification</a>, library usage documentation can be found at <a href="https://pkg.go.dev/r00t2.io/wireproto" target="_blank" rel="noopener">the Golang module documentation page</a>:</p>
 </div>
-<a href="https://pkg.go.dev/go.pkg.dev/r00t2.io/wireproto">
-    <img src="https://pkg.go.dev/badge/go.pkg.dev/r00t2.io/wireproto.svg"
-         alt="Go Reference">
+<a href="https://go.pkg.dev/r00t2.io/wireproto">
+    <img src="https://pkg.go.dev/badge/r00t2.io/wireproto.svg"
+         alt="Go Reference"/>
 </a>
 </div>
 </div>
@@ -630,7 +634,7 @@ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 <div class="ulist">
 <ul>
 <li>
-<p>We know the sizes they <strong>should</strong> be, there&#8217;s no reason to not confirm it.</p>
+<p>The sizes they <strong>should</strong> be are known, there&#8217;s no reason to not confirm it.</p>
 </li>
 </ul>
 </div>
@@ -655,6 +659,15 @@ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 </ul>
 </div>
 </li>
+<li>
+<p><code>.Append*()</code> methods to append any type to any parent type. e.g. <code>&lt;Response&gt;.AppendFVP(&lt;FieldValuePair&gt;)</code> would append an FVP to the most recent ResponseRecord to the most recent ResponseRecordGroup (or create if they don&#8217;t exist), <code>&lt;Response&gt;.AppendRecord(&#8230;&#8203;)</code> for appending a record to most recent record group etc.</p>
+</li>
+<li>
+<p>Better/more strict interfaces</p>
+</li>
+<li>
+<p>Maps should be <code>any</code>, not <code>interface{}</code> values</p>
+</li>
 </ul>
 </div>
 </div>
@@ -662,7 +675,7 @@ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-07-09 16:54:13 -0400
+Last updated 2025-09-25 17:54:36 -0400
 </div>
 </div>
 </body>
--- a/README.md
+++ b/README.md
@@ -0,0 +1,63 @@
+# Reference
+
+In addition to the documentation found in this document and [the
+specification](https://wireproto.io/), library usage documentation can
+be found at [the Golang module documentation
+page](https://pkg.go.dev/r00t2.io/wireproto):
+
+# License
+
+This library is licensed for use, inclusion, and distribution under the
+["3-Clause BSD" license](https://opensource.org/license/bsd-3-clause).
+
+    Copyright (c) 2024 Brent Saner (r00t^2). 
+
+    Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+    1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+    2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+    3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+# TODO
+
+The following are a wishlist or things planned that may come in later
+versions.
+
+-   More clear errors
+
+    -   Currently during e.g. `UnmarshalBinary` calls, just an `io.EOF`
+        will be returned if the buffer is exhausted early. This may be
+        able to be a little more context-helpful by using the `Err*`
+        errors.
+
+-   Confirmation of read/write sizes in buffers
+
+    -   The sizes they **should** be are known, there’s no reason to not
+        confirm it.
+
+-   Goroutines
+
+    -   This of course won’t work for serializing and keeping **order**
+        of children (e.g. RG ⇒ Record); that’d still need to be ordered,
+        but it will allow for parallel parsing **of** those children.
+        Should benchmark, though; it may not be worth it.
+
+-   `context.Context` support for `Read*` and `Write*` funcs
+
+    -   This is a relatively low priority as the passed `net.Conn` will
+        likely return an error if its own context is canceled. This can
+        be handled in the caller downstream.
+
+-   `.Append*()` methods to append any type to any parent type. e.g.
+    `<Response>.AppendFVP(<FieldValuePair>)` would append an FVP to the
+    most recent ResponseRecord to the most recent ResponseRecordGroup
+    (or create if they don’t exist), `<Response>.AppendRecord(…)` for
+    appending a record to most recent record group etc.
+
+-   Better/more strict interfaces
+
+-   Maps should be `any`, not `interface{}` values
--- a/consts.go
+++ b/consts.go
@@ -12,11 +12,14 @@ var (
 )

 const (
+	// IndentDefault is the [IndentChars] to use if not specified.
 	IndentDefault    string = "\t"
+	// SeperatorDefault is the [SeperatorChars] to use if not specified.
 	SeparatorDefault string = "   "
-	maxByteLine      int    = 12 // split if a value is more than this number of bytes..
+	maxByteLine      int    = 12 // (Split a hex string in a Model if a value is more than this number of bytes.)
 )

+// Default indent levels.
 const (
 	indentR uint = iota
 	indentRG
@@ -26,18 +29,18 @@ const (
 const indentOrigRec uint = 2

 const (
-	// ProtoVersion specifies the protocol version for the specification of a Message.
+	// ProtoVersion specifies the protocol version for the specification of a [Message].
 	ProtoVersion uint32 = 1
 )

 const (
 	// PackedNumSize is the size (length of bytes) of a packed unsigned integer.
-	PackedNumSize int = 4 // They're all uint32's.
+	PackedNumSize int = 4 // (They're all uint32's.)
 	// CksumPackedSize is the size (length of bytes) of the checksum algorithm used.
-	CksumPackedSize int = 4 // CRC32 is a big-endian uint32, but if we use a different algo we need to change this.
+	CksumPackedSize int = 4 // CRC32 is represented by a big-endian uint32, but if a different algo is used, this will need to be changed.
 )

-// See https://square-r00t.net/ascii.html for further details.
+// See https://square-r00t.net/ascii.html for further details on ASCII symbols.
 const (
 	AsciiNUL uint8 = iota // 0x00
 	AsciiSOH              // 0x01
@@ -73,6 +76,7 @@ const (
 	AsciiUS               // 0x1f
 )

+// Response Status indicator bytes.
 const (
 	RespStatusByteOK  uint8 = AsciiACK
 	RespStatusByteErr       = AsciiNAK
@@ -95,5 +99,6 @@ var (
 )

 const (
+	// WriteChunkSize is the default size of chunking to use (in bytes) when using chunked Write* functions (i.e. non-segmented).
 	WriteChunkSize int = 1024
 )
--- a/doc.go
+++ b/doc.go
@@ -5,7 +5,5 @@
 For more details and the actual specification, visit [WireProto].

 [WireProto]: https://wireproto.io/
-
-
 */
 package wireproto
--- a/funcs.go
+++ b/funcs.go
@@ -92,7 +92,15 @@ func ReadConnResponse(conn net.Conn) (resp *Response, err error) {
 	var size int
 	var buf *bytes.Buffer = new(bytes.Buffer)

-	// First get the checksum.
+	// Buffer in the status byte...
+	b = make([]byte, 1)
+	if _, err = conn.Read(b); err != nil {
+		return
+	}
+	if _, err = buf.Write(b); err != nil {
+		return
+	}
+	// Then get the checksum. Per spec, *all* responses *must* have a checksum.
 	b = make([]byte, len(hdrCKSUM))
 	if _, err = conn.Read(b); err != nil {
 		return
--- a/funcs_request.go
+++ b/funcs_request.go
@@ -34,7 +34,7 @@ func (r *Request) MarshalBinary() (data []byte, err error) {
 		msgSize += i.Size()
 	}

-	// The message "body" - we do this first so we can checksum (if not nil).
+	// The message "body" - this is done first so the body can be checksummed (if not nil).
 	if _, err = msgBuf.Write(hdrBODYSTART); err != nil {
 		return
 	}
@@ -307,14 +307,14 @@ func (r *Request) UnmarshalBinary(data []byte) (err error) {
 		}
 		r.Checksum = new(uint32)
 		*r.Checksum = byteOrder.Uint32(b)
-		// Since we've only read the checksum, we now also have to read in the MSGSTART...
+		// Since only the checksum has been read, now read the MSGSTART...
 		b = make([]byte, len(hdrMSGSTART))
 		if _, err = buf.Read(b); err != nil {
 			return
 		}
-		// But we don't need to do anything with it.
+		// But don't need to do anything with it.
 	} else {
-		// We've already read MSGSTART as part of the checksum check.
+		// MSGSTART has already been read as part of the checksum check.
 		r.Checksum = nil
 	}

@@ -362,7 +362,7 @@ func (r *Request) UnmarshalBinary(data []byte) (err error) {
 		}
 	}

-	// Now that we've validated the checksum (if provided), we trim the msgBuf to only RGs.
+	// Now that the checksum (if provided) has validated, trim the msgBuf to only RGs.
 	// Skip over the BODYSTART, record group count, and record group size.
 	if _, err = msgBuf.Read(make([]byte, len(hdrBODYSTART)+(PackedNumSize*2))); err != nil {
 		return
@@ -375,7 +375,7 @@ func (r *Request) UnmarshalBinary(data []byte) (err error) {
 	for idx := 0; idx < rgCnt; idx++ {
 		rgBuf = new(bytes.Buffer)

-		// The RG unmarshaler handles the record count, but we need to read it to discard it in msgBuf.
+		// The RG unmarshaler handles the record count, but it needs to be put in msgBuf to do that.
 		if _, err = io.CopyN(rgBuf, msgBuf, int64(PackedNumSize)); err != nil {
 			return
 		}
--- a/funcs_requestrecord.go
+++ b/funcs_requestrecord.go
@@ -186,7 +186,7 @@ func (r *RequestRecord) UnmarshalBinary(data []byte) (err error) {
 	}
 	size = UnpackInt(b)

-	// And now we handle the FVPs themselves.
+	// And now handle the FVPs themselves.
 	b = make([]byte, size)
 	if _, err = buf.Read(b); err != nil {
 		return
--- a/funcs_requestrecordgroup.go
+++ b/funcs_requestrecordgroup.go
@@ -199,8 +199,8 @@ func (r *RequestRecordGroup) UnmarshalBinary(data []byte) (err error) {
 	for idx := 0; idx < cnt; idx++ {
 		recBuf = new(bytes.Buffer)

-		// We skip over the KVP count; that's handled in the record Unmarshaler.
-		// We *do*, however, need to save it to the recBuf.
+		// Skip over the KVP count; that's handled in the record Unmarshaler.
+		// It does, however, need to be written to recBuf.
 		if _, err = io.CopyN(recBuf, buf, int64(PackedNumSize)); err != nil {
 			return
 		}
--- a/funcs_response.go
+++ b/funcs_response.go
@@ -90,7 +90,7 @@ func (r *Response) MarshalBinary() (data []byte, err error) {
 		msgSize += i.Size()
 	}

-	// The message "body" - we do this first so we can checksum .
+	// The message "body" - this is done first so it can be checksummed.
 	if _, err = msgBuf.Write(hdrBODYSTART); err != nil {
 		return
 	}
@@ -120,7 +120,7 @@ func (r *Response) MarshalBinary() (data []byte, err error) {
 		hasErr = true
 	}

-	// Now we write the response as a whole.
+	// Now write the response as a whole.

 	// Status
 	if r.Status == RespStatusByteOK && hasErr {
@@ -130,7 +130,7 @@ func (r *Response) MarshalBinary() (data []byte, err error) {
 		return
 	}

-	// Checksum -- ALWAYS present for responses!
+	// Checksum; ALWAYS present for responses!
 	if _, _, err = r.GenChecksum(); err != nil {
 		return
 	}
@@ -426,7 +426,7 @@ func (r *Response) UnmarshalBinary(data []byte) (err error) {
 		return
 	}

-	// Now that we've validated the checksum, we trim the msgBuf to only RGs.
+	// Now that the checksum has validated, trim the msgBuf to only RGs.
 	// Skip over the BODYSTART, record group count, and record group size.
 	if _, err = msgBuf.Read(make([]byte, len(hdrBODYSTART)+(PackedNumSize*2))); err != nil {
 		return
@@ -439,7 +439,7 @@ func (r *Response) UnmarshalBinary(data []byte) (err error) {
 	for idx := 0; idx < rgCnt; idx++ {
 		rgBuf = new(bytes.Buffer)

-		// The RG unmarshaler handles the record count, but we need to read it into msgBuf.
+		// The RG unmarshaler handles the record count, but it needs to be in msgBuf to do that.
 		if _, err = io.CopyN(rgBuf, msgBuf, int64(PackedNumSize)); err != nil {
 			return
 		}
--- a/funcs_responserecordgroup.go
+++ b/funcs_responserecordgroup.go
@@ -189,8 +189,8 @@ func (r *ResponseRecordGroup) UnmarshalBinary(data []byte) (err error) {
 	for idx := 0; idx < cnt; idx++ {
 		recBuf = new(bytes.Buffer)

-		// We skip over the KVP count; that's handled in the record Unmarshaler.
-		// We *do*, however, need to save it to the recBuf.
+		// Skip over the KVP count; that's handled in the record Unmarshaler.
+		// It does need to be written to recBuf, though.
 		if _, err = io.CopyN(recBuf, buf, int64(PackedNumSize)); err != nil {
 			return
 		}
--- a/go.mod
+++ b/go.mod
@@ -1,8 +1,10 @@
 module r00t2.io/wireproto

-go 1.23
+go 1.24.5
+
+toolchain go1.24.6

 require (
 	github.com/google/uuid v1.6.0
-	r00t2.io/goutils v1.7.0
+	r00t2.io/goutils v1.9.6
 )
--- a/go.sum
+++ b/go.sum
@@ -5,4 +5,6 @@ github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+
 golang.org/x/sys v0.0.0-20211216021012-1d35b9e2eb4e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 r00t2.io/goutils v1.7.0 h1:iQluWlkOyBwOKaK94D5QSnSMYpGKtMb/5WjefmdfHgI=
 r00t2.io/goutils v1.7.0/go.mod h1:9ObJI9S71wDLTOahwoOPs19DhZVYrOh4LEHmQ8SW4Lk=
+r00t2.io/goutils v1.9.6 h1:ZMIIAb16y1AEt1vW1JteHLtblfpnFxyQo2c8AZ3Lf7A=
+r00t2.io/goutils v1.9.6/go.mod h1:76AxpXUeL10uFklxRB11kQsrtj2AKiNm8AwG1bNoBCA=
 r00t2.io/sysutils v1.1.1/go.mod h1:Wlfi1rrJpoKBOjWiYM9rw2FaiZqraD6VpXyiHgoDo/o=
Author	SHA1	Message	Date
brent saner	cefca8ad91	v1.0.3 FIXED: * Link in README * ReadConnResponse was not properly reading in the response status byte before checking the checksum, leading to receiving/parsing Response messages from a net.Conn always failing with an errs.ErrBadHdr. This has been rectified.	2025-09-30 14:15:00 -04:00
brent saner	a86367b5b9	fix readme link to module	2025-09-24 17:00:17 -04:00
brent saner	72818c2d5c	v1.0.2 FIXED: * Dep bumps * Better docs display on pkg.go.dev	2025-08-28 01:26:04 -04:00
brent saner	9b39811206	v1.0.1 FIX: * Cleaned up some documentation	2024-07-10 00:40:12 -04:00