protoutil

Documentation

Overview

Package protoutil contains functions for working with protobuf types.

Index

• Variables
• func GetTypeURL(msg proto.Message) string
• func NewAny(msg proto.Message) *anypb.Any
• func NewAnyBool(v bool) *anypb.Any
• func NewAnyBytes(v []byte) *anypb.Any
• func NewAnyDouble(v float64) *anypb.Any
• func NewAnyFloat(v float32) *anypb.Any
• func NewAnyInt32(v int32) *anypb.Any
• func NewAnyInt64(v int64) *anypb.Any
• func NewAnyNull() *anypb.Any
• func NewAnyString(v string) *anypb.Any
• func NewAnyUInt32(v uint32) *anypb.Any
• func NewAnyUInt64(v uint64) *anypb.Any
• func NewStructBool(v bool) *structpb.Value
• func NewStructList(vs ...*structpb.Value) *structpb.Value
• func NewStructMap(v map[string]*structpb.Value) *structpb.Value
• func NewStructNull() *structpb.Value
• func NewStructNumber(v float64) *structpb.Value
• func NewStructString(v string) *structpb.Value
• func OverwriteMasked(dst, src proto.Message, m *fieldmaskpb.FieldMask) error
• func ToAny(value any) *anypb.Any
• func ToStruct(value any) *structpb.Value
• func Transform(msg proto.Message, f TransformFunc) (proto.Message, error)
• func UnmarshalAnyJSON(data []byte) (*anypb.Any, error)
• type Decryptor
  • func NewDecryptor(keySource cryptutil.KeyEncryptionKeySource) *Decryptor
  • func (dec *Decryptor) Decrypt(src *cryptpb.SealedMessage) (proto.Message, error)
• type Encryptor
  • func NewEncryptor(kek *cryptutil.PublicKeyEncryptionKey) *Encryptor
  • func (enc *Encryptor) Encrypt(msg proto.Message) (*cryptpb.SealedMessage, error)
• type TransformFunc

Variables

var ErrDescriptorMismatch = errors.New("descriptor mismatch")

ErrDescriptorMismatch indicates an operation could not be performed because two proto messages did not have identical descriptors.

Functions

func GetTypeURL

func GetTypeURL(msg proto.Message) string

GetTypeURL gets the TypeURL for a protobuf message.

func NewAny

func NewAny(msg proto.Message) *anypb.Any

NewAny creates a new Any using deterministic serialization.

func NewAnyBool

func NewAnyBool(v bool) *anypb.Any

NewAnyBool creates a new any type from a bool.

func NewAnyBytes

func NewAnyBytes(v []byte) *anypb.Any

NewAnyBytes creates a new any type from bytes.

func NewAnyDouble

func NewAnyDouble(v float64) *anypb.Any

NewAnyDouble creates a new any type from a float64.

func NewAnyFloat

func NewAnyFloat(v float32) *anypb.Any

NewAnyFloat creates a new any type from a float32.

func NewAnyInt32

func NewAnyInt32(v int32) *anypb.Any

NewAnyInt32 creates a new any type from an int32.

func NewAnyInt64

func NewAnyInt64(v int64) *anypb.Any

NewAnyInt64 creates a new any type from an int64.

func NewAnyNull

func NewAnyNull() *anypb.Any

NewAnyNull creates a new any type from a null struct.

func NewAnyString

func NewAnyString(v string) *anypb.Any

NewAnyString creates a new any type from a string.

func NewAnyUInt32

func NewAnyUInt32(v uint32) *anypb.Any

NewAnyUInt32 creates a new any type from an uint32.

func NewAnyUInt64

func NewAnyUInt64(v uint64) *anypb.Any

NewAnyUInt64 creates a new any type from an uint64.

func NewStructBool

func NewStructBool(v bool) *structpb.Value

NewStructBool creates a new bool struct value.

func NewStructList

func NewStructList(vs ...*structpb.Value) *structpb.Value

NewStructList creates a new list struct value.

func NewStructMap

func NewStructMap(v map[string]*structpb.Value) *structpb.Value

NewStructMap creates a new map struct value.

func NewStructNull

func NewStructNull() *structpb.Value

NewStructNull creates a new null struct value.

func NewStructNumber

func NewStructNumber(v float64) *structpb.Value

NewStructNumber creates a new number struct value.

func NewStructString

func NewStructString(v string) *structpb.Value

NewStructString creates a new string struct value.

func OverwriteMasked

func OverwriteMasked(dst, src proto.Message, m *fieldmaskpb.FieldMask) error

OverwriteMasked copies values from src to dst subject to a field mask. It will will return an error if dst and src are not the same type of message, or if some path in the field mask is not valid for that message type.

func ToAny

func ToAny(value any) *anypb.Any

ToAny converts any type into an any value.

func ToStruct

func ToStruct(value any) *structpb.Value

ToStruct converts any value into a structpb Value.

func Transform

func Transform(msg proto.Message, f TransformFunc) (proto.Message, error)

Transform takes in a protobuf message and transforms any basic values with the given function.

func UnmarshalAnyJSON

func UnmarshalAnyJSON(data []byte) (*anypb.Any, error)

UnmarshalAnyJSON unmarshals JSON data into Any

Types

type Decryptor

type Decryptor struct {
	// contains filtered or unexported fields
}

A Decryptor decrypts encrypted protobuf messages.

func NewDecryptor

func NewDecryptor(keySource cryptutil.KeyEncryptionKeySource) *Decryptor

NewDecryptor creates a new decryptor.

func (*Decryptor) Decrypt

func (dec *Decryptor) Decrypt(src *cryptpb.SealedMessage) (proto.Message, error)

Decrypt decrypts an encrypted protobuf message.

type Encryptor

type Encryptor struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

An Encryptor encrypts protobuf messages using a key encryption key and periodically rotated generated data encryption keys.

func NewEncryptor

func NewEncryptor(kek *cryptutil.PublicKeyEncryptionKey) *Encryptor

NewEncryptor returns a new protobuf Encryptor.

func (*Encryptor) Encrypt

func (enc *Encryptor) Encrypt(msg proto.Message) (*cryptpb.SealedMessage, error)

Encrypt encrypts a protobuf message.

type TransformFunc

type TransformFunc func(protoreflect.FieldDescriptor, protoreflect.Value) (protoreflect.Value, error)

TransformFunc is a function that transforms a protobuf value into a new protobuf value.