connectproto

README

connectproto

connectproto allows Connect users to customize the default JSON and binary codecs. It also includes support for the optimized marshaling methods generated by vtprotobuf.

Installation

go get go.akshayshah.org/connectproto

Usage

Use this package's options just like the ones built into connect-go:

opt := connectproto.WithJSON(
  protojson.MarshalOptions{UseProtoNames: true},
  protojson.UnmarshalOptions{DiscardUnknown: true},
)

// The pingv1connect package is generated from your Protocol Buffer schemas
// by protoc-gen-connect-go. You can use connectproto options with 
// both handlers and clients.
route, handler := pingv1connect.NewPingServiceHandler(
  &pingv1connect.UnimplementedPingServiceHandler{},
  opt,
)
client := pingv1connect.NewPingServiceClient(
  http.DefaultClient,
  "https://localhost:8080",
  opt,
)

Status: Unstable

This module is unstable, with a stable release expected before the end of 2023. It supports:

• The two most recent major releases of Go.
• APIv2 of Protocol Buffers in Go (google.golang.org/protobuf).

Within those parameters, connectproto follows semantic versioning.

Legal

Offered under the MIT license.

Documentation

Overview

Package connectproto provides configurable codecs for Connect clients and handlers.

Index

• func WithBinary(marshal proto.MarshalOptions, unmarshal proto.UnmarshalOptions) connect.Option
• func WithBinaryVT() connect.Option
• func WithJSON(marshal protojson.MarshalOptions, unmarshal protojson.UnmarshalOptions) connect.Option

Functions

func WithBinary

func WithBinary(marshal proto.MarshalOptions, unmarshal proto.UnmarshalOptions) connect.Option

WithBinary customizes a connect-go Client or Handler's binary protobuf handling, using any options supported by google.golang.org/protobuf.

func WithBinaryVT

func WithBinaryVT() connect.Option

WithBinaryVT customizes a connect-go Client or Handler's binary protobuf handling, using the optimized marshaling and unmarshaling methods produced by vtprotobuf where possible. If the methods generated by vtprotobuf aren't available, the codec falls back to google.golang.org/protobuf with the default options.

func WithJSON

func WithJSON(marshal protojson.MarshalOptions, unmarshal protojson.UnmarshalOptions) connect.Option

WithJSON customizes a connect-go Client or Handler's JSON handling.