Back to godoc.org
github.com/bufbuild/buf / internal / pkg / protoencoding

Package protoencoding

v0.20.5
Latest Go to latest

The latest major version is .

Published: Jul 24, 2020 | License: Apache-2.0 | Module: github.com/bufbuild/buf

Index

type Marshaler

type Marshaler interface {
	Marshal(message proto.Message) ([]byte, error)
}

Marshaler marshals Messages.

func NewJSONMarshaler

func NewJSONMarshaler(resolver Resolver) Marshaler

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 NewJSONMarshalerIndent

func NewJSONMarshalerIndent(resolver Resolver) Marshaler

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 NewJSONMarshalerUseProtoNames

func NewJSONMarshalerUseProtoNames(resolver Resolver) Marshaler

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 NewWireMarshaler

func NewWireMarshaler() Marshaler

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.

type Resolver

type Resolver interface {
	protoregistry.ExtensionTypeResolver
	protoregistry.MessageTypeResolver
}

Resolver is a Resolver.

This is only needed in cases where extensions may be present.

func NewResolver

func NewResolver(fileDescriptorProtos ...*descriptorpb.FileDescriptorProto) (Resolver, error)

NewResolver creates a New Resolver.

If the input slice is empty, this returns nil The given FileDescriptorProtos 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.

type Unmarshaler

type Unmarshaler interface {
	Unmarshal(data []byte, message proto.Message) error
}

Unmarshaler unmarshals Messages.

func NewJSONUnmarshaler

func NewJSONUnmarshaler(resolver Resolver) Unmarshaler

NewJSONUnmarshaler returns a new Unmarshaler for json.

resolver can be nil if unknown and are only needed for extensions.

func NewWireUnmarshaler

func NewWireUnmarshaler(resolver Resolver) Unmarshaler

NewWireUnmarshaler returns a new Unmarshaler for wire.

resolver can be nil if unknown and are only needed for extensions.

Package Files

Documentation was rendered with GOOS=linux and GOARCH=amd64.

Jump to identifier

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to identifier