Go Encoding

go-encoding is a Go package which abstracts various encoding mechanisms under a unified API.

Requirements

Go 1.13+

Installation

$ go get github.com/Shopify/go-encoding

Usage

Encodings in this package follow either or both of these interfaces:

typeValueEncodinginterface {
Encode(datainterface{}) ([]byte, error)
Decode(b []byte, datainterface{}) error
}
typeStreamEncodinginterface {
StreamEncode(datainterface{}, w io.Writer) errorStreamDecode(r io.Reader, datainterface{}) error
}
typeByteArrayEncodinginterface {
Encode([]byte) ([]byte, error)
Decode([]byte) ([]byte, error)
}
typeByteStreamEncodinginterface {
StreamEncode(io.Writer) (io.WriteCloser, error)
StreamDecode(io.Reader) (io.ReadCloser, error)
}

See example_test.go for how it all fits together.

Encodings

Used to encode arbitrary Go types to a byte array.

Name	ValueEncoding	StreamEncoding	Implementation
Literal	✔		`strconv`
Json	✔	✔	`encoding/json`
Gob		✔	`encoding/gob`

To use a ValueEncoding as a StreamEncoding, you can wrap with NewStreamEncoding.

Or vice-versa by using NewValueEncoding.

Byte Encodings

Used to encode byte arrays to byte arrays, which is useful to do processing like compression, encryption, or base64.

Name	ByteArrayEncoding	ByteStreamEncoding	Implementation
Base32	✔	✔	`encoding/base32`
Base64	✔	✔	`encoding/base64`
Flate	✔	✔	`compress/flate`
Gzip	✔	✔	`compress/gzip`
Hex	✔	✔	`encoding/hex`
Noop	✔	✔	passthrough
Zlib	✔	✔	`compress/zlib`

Go Encoding

go-encoding is a Go package which abstracts various encoding mechanisms under a unified API.

Requirements

Go 1.13+

Installation

$ go get github.com/Shopify/go-encoding

Usage

Encodings in this package follow either or both of these interfaces:

typeValueEncodinginterface {
Encode(datainterface{}) ([]byte, error)
Decode(b []byte, datainterface{}) error
}
typeStreamEncodinginterface {
StreamEncode(datainterface{}, w io.Writer) errorStreamDecode(r io.Reader, datainterface{}) error
}
typeByteArrayEncodinginterface {
Encode([]byte) ([]byte, error)
Decode([]byte) ([]byte, error)
}
typeByteStreamEncodinginterface {
StreamEncode(io.Writer) (io.WriteCloser, error)
StreamDecode(io.Reader) (io.ReadCloser, error)
}

See example_test.go for how it all fits together.

Encodings

Used to encode arbitrary Go types to a byte array.

Name	ValueEncoding	StreamEncoding	Implementation
Literal	✔		`strconv`
Json	✔	✔	`encoding/json`
Gob		✔	`encoding/gob`

To use a ValueEncoding as a StreamEncoding, you can wrap with NewStreamEncoding.

Or vice-versa by using NewValueEncoding.

Byte Encodings

Used to encode byte arrays to byte arrays, which is useful to do processing like compression, encryption, or base64.

Name	ByteArrayEncoding	ByteStreamEncoding	Implementation
Base32	✔	✔	`encoding/base32`
Base64	✔	✔	`encoding/base64`
Flate	✔	✔	`compress/flate`
Gzip	✔	✔	`compress/gzip`
Hex	✔	✔	`encoding/hex`
Noop	✔	✔	passthrough
Zlib	✔	✔	`compress/zlib`

Go Encoding

go-encoding is a Go package which abstracts various encoding mechanisms under a unified API.

Requirements

Go 1.13+

Installation

$ go get github.com/Shopify/go-encoding

Usage

Encodings in this package follow either or both of these interfaces:

typeValueEncodinginterface {
Encode(datainterface{}) ([]byte, error)
Decode(b []byte, datainterface{}) error
}
typeStreamEncodinginterface {
StreamEncode(datainterface{}, w io.Writer) errorStreamDecode(r io.Reader, datainterface{}) error
}
typeByteArrayEncodinginterface {
Encode([]byte) ([]byte, error)
Decode([]byte) ([]byte, error)
}
typeByteStreamEncodinginterface {
StreamEncode(io.Writer) (io.WriteCloser, error)
StreamDecode(io.Reader) (io.ReadCloser, error)
}

See example_test.go for how it all fits together.

Encodings

Used to encode arbitrary Go types to a byte array.

Name	ValueEncoding	StreamEncoding	Implementation
Literal	✔		`strconv`
Json	✔	✔	`encoding/json`
Gob		✔	`encoding/gob`

To use a ValueEncoding as a StreamEncoding, you can wrap with NewStreamEncoding.

Or vice-versa by using NewValueEncoding.

Byte Encodings

Used to encode byte arrays to byte arrays, which is useful to do processing like compression, encryption, or base64.

Name	ByteArrayEncoding	ByteStreamEncoding	Implementation
Base32	✔	✔	`encoding/base32`
Base64	✔	✔	`encoding/base64`
Flate	✔	✔	`compress/flate`
Gzip	✔	✔	`compress/gzip`
Hex	✔	✔	`encoding/hex`
Noop	✔	✔	passthrough
Zlib	✔	✔	`compress/zlib`

Go Encoding

go-encoding is a Go package which abstracts various encoding mechanisms under a unified API.

Requirements

Go 1.13+

Installation

$ go get github.com/Shopify/go-encoding

Usage

Encodings in this package follow either or both of these interfaces:

typeValueEncodinginterface {
Encode(datainterface{}) ([]byte, error)
Decode(b []byte, datainterface{}) error
}
typeStreamEncodinginterface {
StreamEncode(datainterface{}, w io.Writer) errorStreamDecode(r io.Reader, datainterface{}) error
}
typeByteArrayEncodinginterface {
Encode([]byte) ([]byte, error)
Decode([]byte) ([]byte, error)
}
typeByteStreamEncodinginterface {
StreamEncode(io.Writer) (io.WriteCloser, error)
StreamDecode(io.Reader) (io.ReadCloser, error)
}

See example_test.go for how it all fits together.

Encodings

Used to encode arbitrary Go types to a byte array.

Name	ValueEncoding	StreamEncoding	Implementation
Literal	✔		`strconv`
Json	✔	✔	`encoding/json`
Gob		✔	`encoding/gob`

To use a ValueEncoding as a StreamEncoding, you can wrap with NewStreamEncoding.

Or vice-versa by using NewValueEncoding.

Byte Encodings

Used to encode byte arrays to byte arrays, which is useful to do processing like compression, encryption, or base64.

Name	ByteArrayEncoding	ByteStreamEncoding	Implementation
Base32	✔	✔	`encoding/base32`
Base64	✔	✔	`encoding/base64`
Flate	✔	✔	`compress/flate`
Gzip	✔	✔	`compress/gzip`
Hex	✔	✔	`encoding/hex`
Noop	✔	✔	passthrough
Zlib	✔	✔	`compress/zlib`

Go Encoding

go-encoding is a Go package which abstracts various encoding mechanisms under a unified API.

Requirements

Go 1.13+

Installation

$ go get github.com/Shopify/go-encoding

Usage

Encodings in this package follow either or both of these interfaces:

typeValueEncodinginterface {
Encode(datainterface{}) ([]byte, error)
Decode(b []byte, datainterface{}) error
}
typeStreamEncodinginterface {
StreamEncode(datainterface{}, w io.Writer) errorStreamDecode(r io.Reader, datainterface{}) error
}
typeByteArrayEncodinginterface {
Encode([]byte) ([]byte, error)
Decode([]byte) ([]byte, error)
}
typeByteStreamEncodinginterface {
StreamEncode(io.Writer) (io.WriteCloser, error)
StreamDecode(io.Reader) (io.ReadCloser, error)
}

See example_test.go for how it all fits together.

Encodings

Used to encode arbitrary Go types to a byte array.

Name	ValueEncoding	StreamEncoding	Implementation
Literal	✔		`strconv`
Json	✔	✔	`encoding/json`
Gob		✔	`encoding/gob`

To use a ValueEncoding as a StreamEncoding, you can wrap with NewStreamEncoding.

Or vice-versa by using NewValueEncoding.

Byte Encodings

Used to encode byte arrays to byte arrays, which is useful to do processing like compression, encryption, or base64.

Name	ByteArrayEncoding	ByteStreamEncoding	Implementation
Base32	✔	✔	`encoding/base32`
Base64	✔	✔	`encoding/base64`
Flate	✔	✔	`compress/flate`
Gzip	✔	✔	`compress/gzip`
Hex	✔	✔	`encoding/hex`
Noop	✔	✔	passthrough
Zlib	✔	✔	`compress/zlib`

Go Encoding

go-encoding is a Go package which abstracts various encoding mechanisms under a unified API.

Requirements

Go 1.13+

Installation

$ go get github.com/Shopify/go-encoding

Usage

Encodings in this package follow either or both of these interfaces:

typeValueEncodinginterface {
Encode(datainterface{}) ([]byte, error)
Decode(b []byte, datainterface{}) error
}
typeStreamEncodinginterface {
StreamEncode(datainterface{}, w io.Writer) errorStreamDecode(r io.Reader, datainterface{}) error
}
typeByteArrayEncodinginterface {
Encode([]byte) ([]byte, error)
Decode([]byte) ([]byte, error)
}
typeByteStreamEncodinginterface {
StreamEncode(io.Writer) (io.WriteCloser, error)
StreamDecode(io.Reader) (io.ReadCloser, error)
}

See example_test.go for how it all fits together.

Encodings

Used to encode arbitrary Go types to a byte array.

Name	ValueEncoding	StreamEncoding	Implementation
Literal	✔		`strconv`
Json	✔	✔	`encoding/json`
Gob		✔	`encoding/gob`

To use a ValueEncoding as a StreamEncoding, you can wrap with NewStreamEncoding.

Or vice-versa by using NewValueEncoding.

Byte Encodings

Used to encode byte arrays to byte arrays, which is useful to do processing like compression, encryption, or base64.

Name	ByteArrayEncoding	ByteStreamEncoding	Implementation
Base32	✔	✔	`encoding/base32`
Base64	✔	✔	`encoding/base64`
Flate	✔	✔	`compress/flate`
Gzip	✔	✔	`compress/gzip`
Hex	✔	✔	`encoding/hex`
Noop	✔	✔	passthrough
Zlib	✔	✔	`compress/zlib`

Go Encoding

go-encoding is a Go package which abstracts various encoding mechanisms under a unified API.

Requirements

Go 1.13+

Installation

$ go get github.com/Shopify/go-encoding

Usage

Encodings in this package follow either or both of these interfaces:

typeValueEncodinginterface {
Encode(datainterface{}) ([]byte, error)
Decode(b []byte, datainterface{}) error
}
typeStreamEncodinginterface {
StreamEncode(datainterface{}, w io.Writer) errorStreamDecode(r io.Reader, datainterface{}) error
}
typeByteArrayEncodinginterface {
Encode([]byte) ([]byte, error)
Decode([]byte) ([]byte, error)
}
typeByteStreamEncodinginterface {
StreamEncode(io.Writer) (io.WriteCloser, error)
StreamDecode(io.Reader) (io.ReadCloser, error)
}

See example_test.go for how it all fits together.

Encodings

Used to encode arbitrary Go types to a byte array.

Name	ValueEncoding	StreamEncoding	Implementation
Literal	✔		`strconv`
Json	✔	✔	`encoding/json`
Gob		✔	`encoding/gob`

To use a ValueEncoding as a StreamEncoding, you can wrap with NewStreamEncoding.

Or vice-versa by using NewValueEncoding.

Byte Encodings

Used to encode byte arrays to byte arrays, which is useful to do processing like compression, encryption, or base64.

Name	ByteArrayEncoding	ByteStreamEncoding	Implementation
Base32	✔	✔	`encoding/base32`
Base64	✔	✔	`encoding/base64`
Flate	✔	✔	`compress/flate`
Gzip	✔	✔	`compress/gzip`
Hex	✔	✔	`encoding/hex`
Noop	✔	✔	passthrough
Zlib	✔	✔	`compress/zlib`

Go Encoding

go-encoding is a Go package which abstracts various encoding mechanisms under a unified API.

Requirements

Go 1.13+

Installation

$ go get github.com/Shopify/go-encoding

Usage

Encodings in this package follow either or both of these interfaces:

typeValueEncodinginterface {
Encode(datainterface{}) ([]byte, error)
Decode(b []byte, datainterface{}) error
}
typeStreamEncodinginterface {
StreamEncode(datainterface{}, w io.Writer) errorStreamDecode(r io.Reader, datainterface{}) error
}
typeByteArrayEncodinginterface {
Encode([]byte) ([]byte, error)
Decode([]byte) ([]byte, error)
}
typeByteStreamEncodinginterface {
StreamEncode(io.Writer) (io.WriteCloser, error)
StreamDecode(io.Reader) (io.ReadCloser, error)
}

See example_test.go for how it all fits together.

Encodings

Used to encode arbitrary Go types to a byte array.

Name	ValueEncoding	StreamEncoding	Implementation
Literal	✔		`strconv`
Json	✔	✔	`encoding/json`
Gob		✔	`encoding/gob`

To use a ValueEncoding as a StreamEncoding, you can wrap with NewStreamEncoding.

Or vice-versa by using NewValueEncoding.

Byte Encodings

Used to encode byte arrays to byte arrays, which is useful to do processing like compression, encryption, or base64.

Name	ByteArrayEncoding	ByteStreamEncoding	Implementation
Base32	✔	✔	`encoding/base32`
Base64	✔	✔	`encoding/base64`
Flate	✔	✔	`compress/flate`
Gzip	✔	✔	`compress/gzip`
Hex	✔	✔	`encoding/hex`
Noop	✔	✔	passthrough
Zlib	✔	✔	`compress/zlib`

Name		Name	Last commit message	Last commit date
.github		.github
bin		bin
.gitignore		.gitignore
.golangci.yml		.golangci.yml
CHANGELOG.md		CHANGELOG.md
LICENSE		LICENSE
README.md		README.md
base32_encoding.go		base32_encoding.go
base32_encoding_test.go		base32_encoding_test.go
base64_encoding.go		base64_encoding.go
base64_encoding_test.go		base64_encoding_test.go
buffered.go		buffered.go
byte_encoding.go		byte_encoding.go
byte_encoding_test.go		byte_encoding_test.go
chain_byte_encoding.go		chain_byte_encoding.go
chain_byte_encoding_test.go		chain_byte_encoding_test.go
closer.go		closer.go
dev.yml		dev.yml
encoding.go		encoding.go
encoding_test.go		encoding_test.go
encrypter_encoding.go		encrypter_encoding.go
example_test.go		example_test.go
flate_encoding.go		flate_encoding.go
flate_encoding_test.go		flate_encoding_test.go
go.mod		go.mod
go.sum		go.sum
gob_encoding.go		gob_encoding.go
gob_encoding_test.go		gob_encoding_test.go
gzip_encoding.go		gzip_encoding.go
gzip_encoding_test.go		gzip_encoding_test.go
hex_encoding.go		hex_encoding.go
hex_encoding_test.go		hex_encoding_test.go
json_encoding.go		json_encoding.go
json_encoding_test.go		json_encoding_test.go
literal_marshalling.go		literal_marshalling.go
literal_marshalling_test.go		literal_marshalling_test.go
noop_encoding.go		noop_encoding.go
noop_encoding_test.go		noop_encoding_test.go
pointer.go		pointer.go
read_write_encoding.go		read_write_encoding.go
service.yml		service.yml
translators.go		translators.go
wrapped_encoding.go		wrapped_encoding.go
wrapped_encoding_test.go		wrapped_encoding_test.go
zlib_encoding.go		zlib_encoding.go
zlib_encoding_test.go		zlib_encoding_test.go

Name		Name	Last commit message	Last commit date
.github		.github
bin		bin
.gitignore		.gitignore
.golangci.yml		.golangci.yml
CHANGELOG.md		CHANGELOG.md
LICENSE		LICENSE
README.md		README.md
base32_encoding.go		base32_encoding.go
base32_encoding_test.go		base32_encoding_test.go
base64_encoding.go		base64_encoding.go
base64_encoding_test.go		base64_encoding_test.go
buffered.go		buffered.go
byte_encoding.go		byte_encoding.go
byte_encoding_test.go		byte_encoding_test.go
chain_byte_encoding.go		chain_byte_encoding.go
chain_byte_encoding_test.go		chain_byte_encoding_test.go
closer.go		closer.go
dev.yml		dev.yml
encoding.go		encoding.go
encoding_test.go		encoding_test.go
encrypter_encoding.go		encrypter_encoding.go
example_test.go		example_test.go
flate_encoding.go		flate_encoding.go
flate_encoding_test.go		flate_encoding_test.go
go.mod		go.mod
go.sum		go.sum
gob_encoding.go		gob_encoding.go
gob_encoding_test.go		gob_encoding_test.go
gzip_encoding.go		gzip_encoding.go
gzip_encoding_test.go		gzip_encoding_test.go
hex_encoding.go		hex_encoding.go
hex_encoding_test.go		hex_encoding_test.go
json_encoding.go		json_encoding.go
json_encoding_test.go		json_encoding_test.go
literal_marshalling.go		literal_marshalling.go
literal_marshalling_test.go		literal_marshalling_test.go
noop_encoding.go		noop_encoding.go
noop_encoding_test.go		noop_encoding_test.go
pointer.go		pointer.go
read_write_encoding.go		read_write_encoding.go
service.yml		service.yml
translators.go		translators.go
wrapped_encoding.go		wrapped_encoding.go
wrapped_encoding_test.go		wrapped_encoding_test.go
zlib_encoding.go		zlib_encoding.go
zlib_encoding_test.go		zlib_encoding_test.go

Name		Name	Last commit message	Last commit date
.github		.github
bin		bin
.gitignore		.gitignore
.golangci.yml		.golangci.yml
CHANGELOG.md		CHANGELOG.md
LICENSE		LICENSE
README.md		README.md
base32_encoding.go		base32_encoding.go
base32_encoding_test.go		base32_encoding_test.go
base64_encoding.go		base64_encoding.go
base64_encoding_test.go		base64_encoding_test.go
buffered.go		buffered.go
byte_encoding.go		byte_encoding.go
byte_encoding_test.go		byte_encoding_test.go
chain_byte_encoding.go		chain_byte_encoding.go
chain_byte_encoding_test.go		chain_byte_encoding_test.go
closer.go		closer.go
dev.yml		dev.yml
encoding.go		encoding.go
encoding_test.go		encoding_test.go
encrypter_encoding.go		encrypter_encoding.go
example_test.go		example_test.go
flate_encoding.go		flate_encoding.go
flate_encoding_test.go		flate_encoding_test.go
go.mod		go.mod
go.sum		go.sum
gob_encoding.go		gob_encoding.go
gob_encoding_test.go		gob_encoding_test.go
gzip_encoding.go		gzip_encoding.go
gzip_encoding_test.go		gzip_encoding_test.go
hex_encoding.go		hex_encoding.go
hex_encoding_test.go		hex_encoding_test.go
json_encoding.go		json_encoding.go
json_encoding_test.go		json_encoding_test.go
literal_marshalling.go		literal_marshalling.go
literal_marshalling_test.go		literal_marshalling_test.go
noop_encoding.go		noop_encoding.go
noop_encoding_test.go		noop_encoding_test.go
pointer.go		pointer.go
read_write_encoding.go		read_write_encoding.go
service.yml		service.yml
translators.go		translators.go
wrapped_encoding.go		wrapped_encoding.go
wrapped_encoding_test.go		wrapped_encoding_test.go
zlib_encoding.go		zlib_encoding.go
zlib_encoding_test.go		zlib_encoding_test.go

Name		Name	Last commit message	Last commit date
.github		.github
bin		bin
.gitignore		.gitignore
.golangci.yml		.golangci.yml
CHANGELOG.md		CHANGELOG.md
LICENSE		LICENSE
README.md		README.md
base32_encoding.go		base32_encoding.go
base32_encoding_test.go		base32_encoding_test.go
base64_encoding.go		base64_encoding.go
base64_encoding_test.go		base64_encoding_test.go
buffered.go		buffered.go
byte_encoding.go		byte_encoding.go
byte_encoding_test.go		byte_encoding_test.go
chain_byte_encoding.go		chain_byte_encoding.go
chain_byte_encoding_test.go		chain_byte_encoding_test.go
closer.go		closer.go
dev.yml		dev.yml
encoding.go		encoding.go
encoding_test.go		encoding_test.go
encrypter_encoding.go		encrypter_encoding.go
example_test.go		example_test.go
flate_encoding.go		flate_encoding.go
flate_encoding_test.go		flate_encoding_test.go
go.mod		go.mod
go.sum		go.sum
gob_encoding.go		gob_encoding.go
gob_encoding_test.go		gob_encoding_test.go
gzip_encoding.go		gzip_encoding.go
gzip_encoding_test.go		gzip_encoding_test.go
hex_encoding.go		hex_encoding.go
hex_encoding_test.go		hex_encoding_test.go
json_encoding.go		json_encoding.go
json_encoding_test.go		json_encoding_test.go
literal_marshalling.go		literal_marshalling.go
literal_marshalling_test.go		literal_marshalling_test.go
noop_encoding.go		noop_encoding.go
noop_encoding_test.go		noop_encoding_test.go
pointer.go		pointer.go
read_write_encoding.go		read_write_encoding.go
service.yml		service.yml
translators.go		translators.go
wrapped_encoding.go		wrapped_encoding.go
wrapped_encoding_test.go		wrapped_encoding_test.go
zlib_encoding.go		zlib_encoding.go
zlib_encoding_test.go		zlib_encoding_test.go

Name		Name	Last commit message	Last commit date
.github		.github
bin		bin
.gitignore		.gitignore
.golangci.yml		.golangci.yml
CHANGELOG.md		CHANGELOG.md
LICENSE		LICENSE
README.md		README.md
base32_encoding.go		base32_encoding.go
base32_encoding_test.go		base32_encoding_test.go
base64_encoding.go		base64_encoding.go
base64_encoding_test.go		base64_encoding_test.go
buffered.go		buffered.go
byte_encoding.go		byte_encoding.go
byte_encoding_test.go		byte_encoding_test.go
chain_byte_encoding.go		chain_byte_encoding.go
chain_byte_encoding_test.go		chain_byte_encoding_test.go
closer.go		closer.go
dev.yml		dev.yml
encoding.go		encoding.go
encoding_test.go		encoding_test.go
encrypter_encoding.go		encrypter_encoding.go
example_test.go		example_test.go
flate_encoding.go		flate_encoding.go
flate_encoding_test.go		flate_encoding_test.go
go.mod		go.mod
go.sum		go.sum
gob_encoding.go		gob_encoding.go
gob_encoding_test.go		gob_encoding_test.go
gzip_encoding.go		gzip_encoding.go
gzip_encoding_test.go		gzip_encoding_test.go
hex_encoding.go		hex_encoding.go
hex_encoding_test.go		hex_encoding_test.go
json_encoding.go		json_encoding.go
json_encoding_test.go		json_encoding_test.go
literal_marshalling.go		literal_marshalling.go
literal_marshalling_test.go		literal_marshalling_test.go
noop_encoding.go		noop_encoding.go
noop_encoding_test.go		noop_encoding_test.go
pointer.go		pointer.go
read_write_encoding.go		read_write_encoding.go
service.yml		service.yml
translators.go		translators.go
wrapped_encoding.go		wrapped_encoding.go
wrapped_encoding_test.go		wrapped_encoding_test.go
zlib_encoding.go		zlib_encoding.go
zlib_encoding_test.go		zlib_encoding_test.go

Uh oh!

Latest commit

History

Folders and files

Repository files navigation

Go Encoding

Requirements

Installation

Usage

Encodings

Byte Encodings

About

Resources

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages

Uh oh!

Latest commit

History

Folders and files

Repository files navigation

Go Encoding

Requirements

Installation

Usage

Encodings

Byte Encodings

About

Resources

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages

Uh oh!

Latest commit

History

Folders and files

Repository files navigation

Go Encoding

Requirements

Installation

Usage

Encodings

Byte Encodings

About

Resources

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages

Uh oh!

Latest commit

History

Folders and files

Repository files navigation

Go Encoding

Requirements

Installation

Usage

Encodings

Byte Encodings

About

Resources

Code of conduct