-
Notifications
You must be signed in to change notification settings - Fork 451
/
types.go
76 lines (62 loc) · 2.34 KB
/
types.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
// Copyright (c) 2018 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package proto
import (
"io"
"github.com/m3db/m3x/pool"
)
// Marshaler can be marshaled.
type Marshaler interface {
// Size returns the size of the marshaled bytes.
Size() int
// MarshalTo marshals the marshaler into the given byte slice.
MarshalTo(data []byte) (int, error)
}
// Unmarshaler can be unmarshaled from bytes.
type Unmarshaler interface {
// Unmarshal unmarshals the unmarshaler from the given byte slice.
Unmarshal(data []byte) error
}
// Encoder encodes the marshaler.
type Encoder interface {
// Encode encodes the marshaler.
Encode(m Marshaler) error
// Bytes returns the encoded bytes, the bytes could be reused by
// the next encode call.
Bytes() []byte
}
// Decoder decodes into an unmarshaler.
type Decoder interface {
// Decode decodes the unmarshaler.
Decode(m Unmarshaler) error
// ResetReader resets the reader.
ResetReader(r io.Reader)
}
// Options configures a encoder or decoder.
type Options interface {
// MaxMessageSize returns the maximum message size.
MaxMessageSize() int
// SetMaxMessageSize sets the maximum message size.
SetMaxMessageSize(value int) Options
// BytesPool returns the bytes pool.
BytesPool() pool.BytesPool
// SetBytesPool sets the bytes pool.
SetBytesPool(value pool.BytesPool) Options
}