go_wireproto/README.adoc
brent saner d4bb259b83
v1.0.0
Initial release.
2024-07-10 00:18:54 -04:00

2.1 KiB
Raw Blame History

Go WireProto API Documentation

Table of Contents

1. Reference

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

2. License

This library is licensed for use, inclusion, and distribution under the "3-Clause BSD" license.

Full License
Unresolved directive in <stdin> - include::LICENSE[]

3. 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

    • We know the sizes they should be, theres no reason to not confirm it.

  • Goroutines

    • This of course wont work for serializing and keeping order of children (e.g. RG ⇒ Record); thatd 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.