encoding

Documentation

Overview

Package encoding is a wrapper for the core functionality of packages like "encoding/json" and "encoding/gob".

It contains the Codec interface and multiple implementations for encoding Go values to other formats and decode from other formats to Go values. Formats can be JSON, gob etc.

Index

• Variables
• type Codec
• type GobCodec
  • func (c GobCodec) Marshal(v any) ([]byte, error)
  • func (c GobCodec) Unmarshal(data []byte, v any) error
• type JSONcodec
  • func (c JSONcodec) Marshal(v any) ([]byte, error)
  • func (c JSONcodec) Unmarshal(data []byte, v any) error

Variables

var (
	// JSON is a JSONcodec that encodes/decodes Go values to/from JSON.
	JSON = JSONcodec{}
	// Gob is a GobCodec that encodes/decodes Go values to/from gob.
	Gob = GobCodec{}
)

Convenience variables

Types

type Codec

type Codec interface {
	// Marshal encodes a Go value to a slice of bytes.
	Marshal(v any) ([]byte, error)
	// Unmarshal decodes a slice of bytes into a Go value.
	Unmarshal(data []byte, v any) error
}

Codec encodes/decodes Go values to/from slices of bytes.

type GobCodec

type GobCodec struct{}

GobCodec encodes/decodes Go values to/from gob. You can use encoding.Gob instead of creating an instance of this struct.

func (GobCodec) Marshal

func (c GobCodec) Marshal(v any) ([]byte, error)

Marshal encodes a Go value to gob.

func (GobCodec) Unmarshal

func (c GobCodec) Unmarshal(data []byte, v any) error

Unmarshal decodes a gob value into a Go value.

type JSONcodec

type JSONcodec struct{}

JSONcodec encodes/decodes Go values to/from JSON. You can use encoding.JSON instead of creating an instance of this struct.

func (JSONcodec) Marshal

func (c JSONcodec) Marshal(v any) ([]byte, error)

Marshal encodes a Go value to JSON.

func (JSONcodec) Unmarshal

func (c JSONcodec) Unmarshal(data []byte, v any) error

Unmarshal decodes a JSON value into a Go value.