From a0deb620dd182a3fc543cecdd13532575b22f9c1 Mon Sep 17 00:00:00 2001 From: Charles Iliya Krempeaux Date: Thu, 5 Sep 2019 18:29:47 -0700 Subject: [PATCH] docs --- doc.go | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 doc.go diff --git a/doc.go b/doc.go new file mode 100644 index 0000000..c6ced21 --- /dev/null +++ b/doc.go @@ -0,0 +1,23 @@ +/* +Package buffers provides tools for working with byte array, and byte slice buffers, for the Go programming language. + + import "github.com/reiver/go-buffers" + + // ... + + var buffer [1024]byte + + var p []byte = buffer[:] + + writer := buffers.NewWriter(p) + + n, err := writer.Write(data) + + switch casted := err.(type) { + case buffers.TooShort: + //@TODO + default: + return err + } +*/ +package buffers