diff --git a/.githooks/pre-commit/01-docgen b/.githooks/pre-commit/01-docgen index 427d9a6..a229a62 100755 --- 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" diff --git a/README.adoc b/README.adoc index 78912ab..d93e6fe 100644 --- a/README.adoc +++ b/README.adoc @@ -26,9 +26,9 @@ Last rendered {localdatetime} 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^]: ++++ - - Go Reference + + Go Reference ++++ diff --git a/README.html b/README.html index 2de4e18..79f37c6 100644 --- 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 {
Brent Saner
bts@square-r00t.net
-Last rendered 2024-07-10 00:40:13 -0400 +Last rendered 2025-08-28 01:26:10 -0400
Table of Contents
@@ -573,9 +577,9 @@ pre.rouge .gs {

In addition to the documentation found in this document and the specification, library usage documentation can be found at the Golang module documentation page:

- - Go Reference + + Go Reference
@@ -662,7 +666,7 @@ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND diff --git a/README.md b/README.md new file mode 100644 index 0000000..f3e150c --- /dev/null +++ b/README.md @@ -0,0 +1,53 @@ +# 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/go.pkg.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. diff --git a/doc.go b/doc.go index 119fe8d..b36c247 100644 --- 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 diff --git a/go.mod b/go.mod index 35782b1..82f49f8 100644 --- 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 ) diff --git a/go.sum b/go.sum index 05a4759..5585890 100644 --- 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=