encoding

package

v2.280.0 Latest Latest Go to latest Published: Feb 13, 2026 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/alexfalkowski/go-service

Links

Open Source Insights

Documentation ¶

Overview ¶

Package encoding provides encoding helpers and adapters used by go-service.

Constants ¶

This section is empty.

Variables ¶

View Source

var Module = di.Module(
	di.Constructor(proto.NewBinary),
	di.Constructor(proto.NewText),
	di.Constructor(proto.NewJSON),
	di.Constructor(json.NewEncoder),
	di.Constructor(toml.NewEncoder),
	di.Constructor(yaml.NewEncoder),
	di.Constructor(gob.NewEncoder),
	di.Constructor(bytes.NewEncoder),
	di.Constructor(NewMap),
)

Module for fx.

Functions ¶

This section is empty.

Types ¶

type Encoder ¶

type Encoder interface {
	// Encode any to a writer.
	Encode(w io.Writer, v any) error

	// Decode any from a reader.
	Decode(r io.Reader, v any) error
}

Encoder allows different types of encoding/decoding.

type Map ¶

type Map struct {
	// contains filtered or unexported fields
}

Map of encoding.

func NewMap ¶

func NewMap(params MapParams) *Map

NewMap for encoding.

func (*Map) Get ¶

func (f *Map) Get(kind string) Encoder

Get from kind.

func (*Map) Keys ¶

func (f *Map) Keys() []string

Keys from the encoders map.

func (*Map) Register ¶

func (f *Map) Register(kind string, enc Encoder)

Register kind and encoder.

type MapParams ¶

type MapParams struct {
	di.In
	JSON        *json.Encoder
	YAML        *yaml.Encoder
	TOML        *toml.Encoder
	ProtoBinary *proto.Binary
	ProtoText   *proto.Text
	ProtoJSON   *proto.JSON
	GOB         *gob.Encoder
	Bytes       *bytes.Encoder
}

MapParams for encoding.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
base64 Package base64 provides encoding helpers and adapters used by go-service.	Package base64 provides encoding helpers and adapters used by go-service.
bytes Package bytes provides byte-oriented encoding helpers and adapters used by go-service.	Package bytes provides byte-oriented encoding helpers and adapters used by go-service.
errors Package errors provides encoding helpers and adapters used by go-service.	Package errors provides encoding helpers and adapters used by go-service.
gob Package gob provides Gob encoding helpers and adapters used by go-service.	Package gob provides Gob encoding helpers and adapters used by go-service.
json Package json provides JSON encoding helpers and adapters used by go-service.	Package json provides JSON encoding helpers and adapters used by go-service.
proto Package proto provides Protocol Buffers (protobuf) encoding helpers and adapters used by go-service.	Package proto provides Protocol Buffers (protobuf) encoding helpers and adapters used by go-service.
toml Package toml provides TOML encoding helpers and adapters used by go-service.	Package toml provides TOML encoding helpers and adapters used by go-service.
yaml Package yaml provides YAML encoding helpers and adapters used by go-service.	Package yaml provides YAML encoding helpers and adapters used by go-service.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL