protoutil

Documentation

Index

• func DecompressAndUnmarshall[T proto.Message](buf []byte, msg T, decompressor compress.Decompressor) (T, error)
• func Hash(msg proto.Message) ([]byte, error)
• func HashMany[T proto.Message](msgs []T) ([]byte, error)
• func MarshallAndCompress(msg proto.Message, compressor compress.Compressor) ([]byte, error)
• func MustDecompressAndUnmarshall[T proto.Message](buf []byte, msg T, decompressor compress.Decompressor) T
• func MustMarshall(msg proto.Message) []byte
• func MustMarshallAndCompress(msg proto.Message, compressor compress.Compressor) []byte
• func MustUnmarshall[T proto.Message](buf []byte, msg T) T
• func Unmarshall[T proto.Message](buf []byte, msg T) (T, error)

Functions

func DecompressAndUnmarshall

func DecompressAndUnmarshall[T proto.Message](buf []byte, msg T, decompressor compress.Decompressor) (T, error)

DecompressAndUnmarshall first decompressed the message and then unmarshalls

func Hash

func Hash(msg proto.Message) ([]byte, error)

Hash produces a 160 bit hash of the supplied proto object

func HashMany

func HashMany[T proto.Message](msgs []T) ([]byte, error)

HashMany produces a 160 bit hash of the supplied proto objects

func MarshallAndCompress

func MarshallAndCompress(msg proto.Message, compressor compress.Compressor) ([]byte, error)

MarshallAndCompress first marshalls the supplied proto message and then compresses it.

func MustDecompressAndUnmarshall

func MustDecompressAndUnmarshall[T proto.Message](buf []byte, msg T, decompressor compress.Decompressor) T

MustDecompressAndUnmarshall first decompressed the message and then unmarshalls. If either of these steps fail then it will panic. The main use case here is for unit tests. Think carefully if you intend to use this elsewhere

func MustMarshall

func MustMarshall(msg proto.Message) []byte

MustMarshall marshalls a proto message and panics if the unmarshall fails. The main use case here is for unit tests. Think carefully if you intend to use this elsewhere

func MustMarshallAndCompress

func MustMarshallAndCompress(msg proto.Message, compressor compress.Compressor) []byte

MustMarshallAndCompress first marshalls the supplied proto message and then compresses it. If either of these steps fail then it will panic. The main use case here is for unit tests. Think carefully if you intend to use this elsewhere

func MustUnmarshall

func MustUnmarshall[T proto.Message](buf []byte, msg T) T

MustUnmarshall unmarshalls a proto message and panics if the unmarshall fails. The main use case here is for unit tests. Think carefully if you intend to use this elsewhere

func Unmarshall

func Unmarshall[T proto.Message](buf []byte, msg T) (T, error)

Unmarshall unmarshalls a proto message in a type-safe way. Hopefully go-generics will one day be powerful enough that we won't need the msg param