coder

README

Coder

The coder package implements three interfaces with debug logging:

• Encoder encodes and writes values to an output stream.
• Decoder reads and decodes values from an input stream.
• Coder is a pair of Encoder and Decoder.

Getting Started

package main

import (
	"bytes"
	"encoding/json"
	"fmt"

	"github.com/gromey/proto-rest/coder"
)

func main() {
	coderJSON := coder.NewCoder("application/json", json.Marshal, json.Unmarshal)

	var buf bytes.Buffer

	in := &struct {
		A string `json:"a"`
	}{A: "AAA"}

	if err := coderJSON.Encode(&buf, in); err != nil {
		panic(err)
	}

	fmt.Printf("encoded: %s\n", buf.String())
	// encoded: {"a":"AAA"}

	out := &struct {
		A string `json:"a"`
	}{}

	if err := coderJSON.Decode(&buf, out); err != nil {
		panic(err)
	}

	fmt.Printf("decoded: %+v\n", out)
	// decoded: &{A:AAA}
}

Documentation

Index

• Constants
• type Coder
  • func NewCoder(contentType string, marshal func(v any) ([]byte, error), ...) Coder
• type Decoder
  • func NewDecoder(unmarshal func(data []byte, v any) error) Decoder
• type Encoder
  • func NewEncoder(marshal func(v any) ([]byte, error)) Encoder

Constants

const ContentType = "Content-Type"

Types

type Coder

type Coder interface {
	ContentType() string
	Encoder
	Decoder
}

A Coder is a pair of Encoder and Decoder.

func NewCoder

func NewCoder(contentType string, marshal func(v any) ([]byte, error), unmarshal func(data []byte, v any) error) Coder

NewCoder returns a new Coder.

type Decoder

type Decoder interface {
	Decode(r io.Reader, v any) error
}

A Decoder reads and decodes values from an input stream.

func NewDecoder

func NewDecoder(unmarshal func(data []byte, v any) error) Decoder

NewDecoder returns a new Decoder that reads from r.

type Encoder

type Encoder interface {
	Encode(w io.Writer, v any) error
}

An Encoder encodes and writes values to an output stream.

func NewEncoder

func NewEncoder(marshal func(v any) ([]byte, error)) Encoder

NewEncoder returns a new Encoder that writes to w.