go_wireproto/README.adoc

Go WireProto API Documentation

Table of Contents

• 1. Reference
• 2. License
• 3. TODO

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:

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

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