add to todo

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 15:49:54 -04:00 · 2025-09-30 14:15:00 -04:00 · 2025-09-24 17:00:17 -04:00 · 2025-08-28 01:26:04 -04:00
8 changed files with 208 additions and 15 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>
 ++++

@@ -57,3 +57,16 @@ The following are a wishlist or things planned that may come in later versions.
 ** 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.
+* Better/more strict interfaces
+* Maps for generic should have `any`, not `interface{}` values
+* FVP should have its own method to a map[string][]byte return value
+* "Getters and Setters" (ew, I know, but compromises are made with flexibility)
+** `.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.
+** `.Get()`/`.Set()` on a Response/Request to get/set a slice of values (`<FieldValue>`) from filter criteria as struct (e.g. field name, how many, first X, last X, etc.)
+** `.GetPath*()` and `.SetPath*()` to use *[`RG_N`[`R_N`[`FVP_N`]]]* indexing (e.g. `0, 0, 0` for RecordGroup 0/Record 0/FVP 0, `1, 3, 5` for RecordGroup 1/Record 3/FVP 5, etc.) multidimentional indexing
+*** Allow specific lookups/sets by multidimentional array index to return FVP (`.GetIndex(idx)` where `idx` is a fixed-size array of dimensions for object's children paths); e.g. `<Response>.GetIndex(idx)`, `idx` is `[3]int` and returns FVP)
+*** Allow lookups/sets by variable length index (`.GetIndexDynamic(idx)`, where `idx` is a `1` to `n`-size slice of dimensions for object's children paths (e.g. `<Response>.GetIndexDynamic([]int{0, 0})` returns `any(<Record>)` but `<Response>.GetIndexDynamic([]int{0, 0, 0})` returns `any(FieldValuePair)`)
+**** negative value indicates *all* children
+*** Lookups/sets at fixed levels (e.g. `<RecordGroup>.GetRecord(idx)`, `idx` is `[1]int`, but `<RecordGroup>.GetFVP(idx)`, `idx` is `[2]int`) for type safety
+*** All objects have `.ID()` that returns their index/"path"/"key" from the root, and `.Index()` that returns their index within their immediate parent
+**** This obviously requires a `.Resolve()` first
--- 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:40:13 -0400</span>
+<span id="revdate">Last rendered 2025-09-30 15:49:54 -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>
@@ -655,6 +659,61 @@ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 </ul>
 </div>
 </li>
+<li>
+<p>Better/more strict interfaces</p>
+</li>
+<li>
+<p>Maps for generic should have <code>any</code>, not <code>interface{}</code> values</p>
+</li>
+<li>
+<p>FVP should have its own method to a map[string][]byte return value</p>
+</li>
+<li>
+<p>"Getters and Setters" (ew, I know, but compromises are made with flexibility)</p>
+<div class="ulist">
+<ul>
+<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><code>.Get()</code>/<code>.Set()</code> on a Response/Request to get/set a slice of values (<code>&lt;FieldValue&gt;</code>) from filter criteria as struct (e.g. field name, how many, first X, last X, etc.)</p>
+</li>
+<li>
+<p><code>.GetPath*()</code> and <code>.SetPath*()</code> to use <strong>[<code>RG_N</code>[<code>R_N</code>[<code>FVP_N</code>]]]</strong> indexing (e.g. <code>0, 0, 0</code> for RecordGroup 0/Record 0/FVP 0, <code>1, 3, 5</code> for RecordGroup 1/Record 3/FVP 5, etc.) multidimentional indexing</p>
+<div class="ulist">
+<ul>
+<li>
+<p>Allow specific lookups/sets by multidimentional array index to return FVP (<code>.GetIndex(idx)</code> where <code>idx</code> is a fixed-size array of dimensions for object&#8217;s children paths); e.g. <code>&lt;Response&gt;.GetIndex(idx)</code>, <code>idx</code> is <code>[3]int</code> and returns FVP)</p>
+</li>
+<li>
+<p>Allow lookups/sets by variable length index (<code>.GetIndexDynamic(idx)</code>, where <code>idx</code> is a <code>1</code> to <code>n</code>-size slice of dimensions for object&#8217;s children paths (e.g. <code>&lt;Response&gt;.GetIndexDynamic([]int{0, 0})</code> returns <code>any(&lt;Record&gt;)</code> but <code>&lt;Response&gt;.GetIndexDynamic([]int{0, 0, 0})</code> returns <code>any(FieldValuePair)</code>)</p>
+<div class="ulist">
+<ul>
+<li>
+<p>negative value indicates <strong>all</strong> children</p>
+</li>
+</ul>
+</div>
+</li>
+<li>
+<p>Lookups/sets at fixed levels (e.g. <code>&lt;RecordGroup&gt;.GetRecord(idx)</code>, <code>idx</code> is <code>[1]int</code>, but <code>&lt;RecordGroup&gt;.GetFVP(idx)</code>, <code>idx</code> is <code>[2]int</code>) for type safety</p>
+</li>
+<li>
+<p>All objects have <code>.ID()</code> that returns their index/"path"/"key" from the root, and <code>.Index()</code> that returns their index within their immediate parent</p>
+<div class="ulist">
+<ul>
+<li>
+<p>This obviously requires a <code>.Resolve()</code> first</p>
+</li>
+</ul>
+</div>
+</li>
+</ul>
+</div>
+</li>
+</ul>
+</div>
+</li>
 </ul>
 </div>
 </div>
@@ -662,7 +721,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-10 00:21:48 -0400
+Last updated 2025-09-30 15:47:24 -0400
 </div>
 </div>
 </body>
--- a/README.md
+++ b/README.md
@@ -0,0 +1,106 @@
+# 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.
+
+-   Better/more strict interfaces
+
+-   Maps for generic should have `any`, not `interface{}` values
+
+-   FVP should have its own method to a map\[string\]\[\]byte return
+    value
+
+-   "Getters and Setters" (ew, I know, but compromises are made with
+    flexibility)
+
+    -   `.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.
+
+    -   `.Get()`/`.Set()` on a Response/Request to get/set a slice of
+        values (`<FieldValue>`) from filter criteria as struct (e.g.
+        field name, how many, first X, last X, etc.)
+
+    -   `.GetPath*()` and `.SetPath*()` to use
+        **\[`RG_N`\[`R_N`\[`FVP_N`\]\]\]** indexing (e.g. `0, 0, 0` for
+        RecordGroup 0/Record 0/FVP 0, `1, 3, 5` for RecordGroup 1/Record
+        3/FVP 5, etc.) multidimentional indexing
+
+        -   Allow specific lookups/sets by multidimentional array index
+            to return FVP (`.GetIndex(idx)` where `idx` is a fixed-size
+            array of dimensions for object’s children paths); e.g.
+            `<Response>.GetIndex(idx)`, `idx` is `[3]int` and returns
+            FVP)
+
+        -   Allow lookups/sets by variable length index
+            (`.GetIndexDynamic(idx)`, where `idx` is a `1` to `n`-size
+            slice of dimensions for object’s children paths (e.g.
+            `<Response>.GetIndexDynamic([]int{0, 0})` returns
+            `any(<Record>)` but
+            `<Response>.GetIndexDynamic([]int{0, 0, 0})` returns
+            `any(FieldValuePair)`)
+
+            -   negative value indicates **all** children
+
+        -   Lookups/sets at fixed levels (e.g.
+            `<RecordGroup>.GetRecord(idx)`, `idx` is `[1]int`, but
+            `<RecordGroup>.GetFVP(idx)`, `idx` is `[2]int`) for type
+            safety
+
+        -   All objects have `.ID()` that returns their
+            index/"path"/"key" from the root, and `.Index()` that
+            returns their index within their immediate parent
+
+            -   This obviously requires a `.Resolve()` first
--- 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/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	edf1c53800	add to todo	2025-09-30 15:49:54 -04:00
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