README
¶
zfmt
Installation
go get -u github.com/zillow/zfmt
Note that zap only supports the two most recent minor versions of Go.
About
Note that zap only supports the two most recent minor versions of Go.
A module which defines several concrete Formatter types responsible for serializing/deserializing objects.
The module centralizes this functionality and is leveraged by several zillow transport libs for use in configuration
driven serialization.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AvroFormatter ¶
type AvroFormatter struct{}
type Formatter ¶
Formatter allows the user to extend formatting capability to unsupported data types
func GetFormatter ¶
func GetFormatter(fmt FormatterType, schemaID int) (Formatter, error)
GetFormatter returns supported formatter from its name
type FormatterType ¶
type FormatterType string
FormatterType defines a formatter
const ( // JSONFmt indicates json formatter JSONFmt FormatterType = "json" // ProtoRawFmt indicates protocol buffer formatter. Does not Base64 encode/decode. ProtoRawFmt FormatterType = "proto_raw" // ProtoBase64Fmt indicates protocol buffer formatter. Base64 encodes/decodes the message. Only intended for use with SQS. ProtoBase64Fmt FormatterType = "proto_base64" // ProtoJSONFmt indicates usage protojson formatter (which should be used for json formatted proto messages). ProtoJSONFmt FormatterType = "proto_json" // StringFmt indicates string formatter StringFmt FormatterType = "string" // AvroFmt indicates apache avro formatter AvroFmt FormatterType = "avro" // AvroSchemaFmt indicates apache avro formatter with schemaID encoded AvroSchemaFmt FormatterType = "avro_schema" // JSONSchemaFmt indicates json formatter with schemaID encoded JSONSchemaFmt FormatterType = "json_schema" // ProtoSchemaDeprecatedFmt indicates proto formatter with schemaID encoded - deprecated because it doesn't work properly. ProtoSchemaDeprecatedFmt FormatterType = "proto_schema_deprecated" )
type GeneratedAvroRecord ¶
type GeneratedAvroRecord interface {
soe.AvroRecord
types.Field
Schema() string
}
GeneratedAvroRecord combines interfaces that make Encoding/Decoding possible for gogen-avro struct
type JSONFormatter ¶
type JSONFormatter struct{}
JSONFormatter encodes/decodes go struct to json format
type ProtoJSONFormatter ¶
type ProtoJSONFormatter struct{}
ProtoJSONFormatter encodes/decodes proto go struct to json format
type ProtobufBase64Formatter ¶
type ProtobufBase64Formatter struct{}
ProtobufBase64Formatter implements formatter interface for both protobuf v1 and v2 messages. Intended for use with SQS
type ProtobufRawFormatter ¶
type ProtobufRawFormatter struct{}
ProtobufRawFormatter implements formatter interface for both protobuf v1 and v2 messages. Does not base64 encode.
type SchematizedAvroFormatter ¶
type SchematizedAvroFormatter struct {
SchemaID int
// contains filtered or unexported fields
}
SchematizedAvroFormatter follows the Confluent Wire Format https://docs.confluent.io/current/schema-registry/serdes-develop/index.html#wire-format
type SchematizedJSONFormatter ¶
type SchematizedJSONFormatter struct {
SchemaID int
// contains filtered or unexported fields
}
SchematizedJSONFormatter follows the Confluent Wire Format https://docs.confluent.io/current/schema-registry/serdes-develop/index.html#wire-format
type SchematizedProtoFormatterDeprecated ¶
type SchematizedProtoFormatterDeprecated struct {
SchemaID int
// contains filtered or unexported fields
}
SchematizedProtoFormatterDeprecated follows the Confluent Wire Format https://docs.confluent.io/current/schema-registry/serdes-develop/index.html#wire-format
type StringFormatter ¶
type StringFormatter struct{}
StringFormatter ...
Source Files
Directories