aboutsummaryrefslogtreecommitdiff
path: root/vendor/github.com/golang/snappy/snappy.go
diff options
context:
space:
mode:
authorGravatar Miek Gieben <miek@miek.nl> 2018-06-30 17:07:33 +0100
committerGravatar Yong Tang <yong.tang.github@outlook.com> 2018-06-30 09:07:33 -0700
commit9d555ab8d2f712a50ec1b7f46de0a7405a28eb9a (patch)
treecd63fcaa57bcd2ca5376dc40c3cd7a04b3909dc0 /vendor/github.com/golang/snappy/snappy.go
parent6fe27d99be622f69ac0b1d402a67a571c6f6166e (diff)
downloadcoredns-9d555ab8d2f712a50ec1b7f46de0a7405a28eb9a.tar.gz
coredns-9d555ab8d2f712a50ec1b7f46de0a7405a28eb9a.tar.zst
coredns-9d555ab8d2f712a50ec1b7f46de0a7405a28eb9a.zip
Dep ensure -update (#1912)
* dep ensure -update Signed-off-by: Miek Gieben <miek@miek.nl> * Add new files Signed-off-by: Miek Gieben <miek@miek.nl>
Diffstat (limited to 'vendor/github.com/golang/snappy/snappy.go')
-rw-r--r--vendor/github.com/golang/snappy/snappy.go17
1 files changed, 14 insertions, 3 deletions
diff --git a/vendor/github.com/golang/snappy/snappy.go b/vendor/github.com/golang/snappy/snappy.go
index 0cf5e379c..ece692ea4 100644
--- a/vendor/github.com/golang/snappy/snappy.go
+++ b/vendor/github.com/golang/snappy/snappy.go
@@ -2,10 +2,21 @@
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
-// Package snappy implements the snappy block-based compression format.
-// It aims for very high speeds and reasonable compression.
+// Package snappy implements the Snappy compression format. It aims for very
+// high speeds and reasonable compression.
//
-// The C++ snappy implementation is at https://github.com/google/snappy
+// There are actually two Snappy formats: block and stream. They are related,
+// but different: trying to decompress block-compressed data as a Snappy stream
+// will fail, and vice versa. The block format is the Decode and Encode
+// functions and the stream format is the Reader and Writer types.
+//
+// The block format, the more common case, is used when the complete size (the
+// number of bytes) of the original data is known upfront, at the time
+// compression starts. The stream format, also known as the framing format, is
+// for when that isn't always true.
+//
+// The canonical, C++ implementation is at https://github.com/google/snappy and
+// it only implements the block format.
package snappy // import "github.com/golang/snappy"
import (