opensource/grpc-go
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

documentation: Mark compresser and decompresser as deprecated (#1971)

Browse Source
This commit is contained in:
Menghan Li
2018-04-06 11:05:14 -07:00
committed by lyuxuan
parent 85ce056528
commit 30fb59a430
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
rpc_util.go
View File

@ -43,6 +43,8 @@ import (
) )
// Compressor defines the interface gRPC uses to compress a message. // Compressor defines the interface gRPC uses to compress a message.
//
// Deprecated: use package encoding.
type Compressor interface { type Compressor interface {
// Do compresses p into w. // Do compresses p into w.
Do(w io.Writer, p []byte) error Do(w io.Writer, p []byte) error
@ -55,6 +57,8 @@ type gzipCompressor struct {
} }
// NewGZIPCompressor creates a Compressor based on GZIP. // NewGZIPCompressor creates a Compressor based on GZIP.
//
// Deprecated: use package encoding/gzip.
func NewGZIPCompressor() Compressor { func NewGZIPCompressor() Compressor {
c, _ := NewGZIPCompressorWithLevel(gzip.DefaultCompression) c, _ := NewGZIPCompressorWithLevel(gzip.DefaultCompression)
return c return c
@ -64,6 +68,8 @@ func NewGZIPCompressor() Compressor {
// of assuming DefaultCompression. // of assuming DefaultCompression.
// //
// The error returned will be nil if the level is valid. // The error returned will be nil if the level is valid.
//
// Deprecated: use package encoding/gzip.
func NewGZIPCompressorWithLevel(level int) (Compressor, error) { func NewGZIPCompressorWithLevel(level int) (Compressor, error) {
if level < gzip.DefaultCompression || level > gzip.BestCompression { if level < gzip.DefaultCompression || level > gzip.BestCompression {
return nil, fmt.Errorf("grpc: invalid compression level: %d", level) return nil, fmt.Errorf("grpc: invalid compression level: %d", level)
@ -96,6 +102,8 @@ func (c *gzipCompressor) Type() string {
} }
// Decompressor defines the interface gRPC uses to decompress a message. // Decompressor defines the interface gRPC uses to decompress a message.
//
// Deprecated: use package encoding.
type Decompressor interface { type Decompressor interface {
// Do reads the data from r and uncompress them. // Do reads the data from r and uncompress them.
Do(r io.Reader) ([]byte, error) Do(r io.Reader) ([]byte, error)
@ -108,6 +116,8 @@ type gzipDecompressor struct {
} }
// NewGZIPDecompressor creates a Decompressor based on GZIP. // NewGZIPDecompressor creates a Decompressor based on GZIP.
//
// Deprecated: use package encoding/gzip.
func NewGZIPDecompressor() Decompressor { func NewGZIPDecompressor() Decompressor {
return &gzipDecompressor{} return &gzipDecompressor{}
} }