forked from bufbuild/buf
-
Notifications
You must be signed in to change notification settings - Fork 0
/
protoencoding.go
105 lines (92 loc) · 3.64 KB
/
protoencoding.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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
// Copyright 2020-2023 Buf Technologies, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package protoencoding
import (
"github.com/xiaoyawei/buf/private/pkg/protodescriptor"
"google.golang.org/protobuf/proto"
"google.golang.org/protobuf/reflect/protoregistry"
)
// Resolver is a Resolver.
//
// This is only needed in cases where extensions may be present.
type Resolver interface {
protoregistry.ExtensionTypeResolver
protoregistry.MessageTypeResolver
}
// NewResolver creates a new Resolver.
//
// If the input slice is empty, this returns nil
// The given FileDescriptors must be self-contained, that is they must contain all imports.
// This can NOT be guaranteed for FileDescriptorSets given over the wire, and can only be guaranteed from builds.
func NewResolver(fileDescriptors ...protodescriptor.FileDescriptor) (Resolver, error) {
return newResolver(fileDescriptors...)
}
// NewLazyResolver creates a new Resolver that is constructed from the given
// descriptors only as needed, if invoked.
//
// If there is an error when constructing the resolver, it will be returned by all
// method calls of the returned resolver.
func NewLazyResolver(fileDescriptors ...protodescriptor.FileDescriptor) Resolver {
return &lazyResolver{fn: func() (Resolver, error) {
return newResolver(fileDescriptors...)
}}
}
// Marshaler marshals Messages.
type Marshaler interface {
Marshal(message proto.Message) ([]byte, error)
}
// NewWireMarshaler returns a new Marshaler for wire.
//
// See https://godoc.org/google.golang.org/protobuf/proto#MarshalOptions for a discussion on stability.
// This has the potential to be unstable over time.
func NewWireMarshaler() Marshaler {
return newWireMarshaler()
}
// NewJSONMarshaler returns a new Marshaler for JSON.
//
// This has the potential to be unstable over time.
// resolver can be nil if unknown and are only needed for extensions.
func NewJSONMarshaler(resolver Resolver) Marshaler {
return newJSONMarshaler(resolver, "", false)
}
// NewJSONMarshalerIndent returns a new Marshaler for JSON with indents.
//
// This has the potential to be unstable over time.
// resolver can be nil if unknown and are only needed for extensions.
func NewJSONMarshalerIndent(resolver Resolver) Marshaler {
return newJSONMarshaler(resolver, " ", false)
}
// NewJSONMarshalerUseProtoNames returns a new Marshaler for JSON using the proto names for keys.
//
// This has the potential to be unstable over time.
// resolver can be nil if unknown and are only needed for extensions.
func NewJSONMarshalerUseProtoNames(resolver Resolver) Marshaler {
return newJSONMarshaler(resolver, "", true)
}
// Unmarshaler unmarshals Messages.
type Unmarshaler interface {
Unmarshal(data []byte, message proto.Message) error
}
// NewWireUnmarshaler returns a new Unmarshaler for wire.
//
// resolver can be nil if unknown and are only needed for extensions.
func NewWireUnmarshaler(resolver Resolver) Unmarshaler {
return newWireUnmarshaler(resolver)
}
// NewJSONUnmarshaler returns a new Unmarshaler for json.
//
// resolver can be nil if unknown and are only needed for extensions.
func NewJSONUnmarshaler(resolver Resolver) Unmarshaler {
return newJSONUnmarshaler(resolver)
}