go-buffers/README.md

33 lines
642 B
Markdown
Raw Normal View History

2019-09-06 01:28:37 +00:00
# go-buffers
Package **buffers** provides tools for working with byte array, and byte slice buffers.
## Documention
Online documentation, which includes examples, can be found at: http://godoc.org/sourcecode.social/reiver/go-buffers
2019-09-06 01:28:37 +00:00
[![GoDoc](https://godoc.org/sourcecode.social/reiver/go-buffers?status.svg)](https://godoc.org/sourcecode.social/reiver/go-buffers)
2019-09-06 01:28:37 +00:00
## Example
```go
import "sourcecode.social/reiver/go-buffers"
2019-09-06 01:28:37 +00:00
// ...
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
}
```