io

Documentation

Overview

Package io contains the serialization interfaces used by perun.

Index

• func Decode(reader io.Reader, values ...Decoder) error
• func Encode(writer io.Writer, values ...Encoder) error
• type Decoder
• type Encoder
• type Serializer

Functions

func Decode

func Decode(reader io.Reader, values ...Decoder) error

Decode decodes multiple serializer objects at once. If an error occurs, the index at which it occurred is also reported.

func Encode

func Encode(writer io.Writer, values ...Encoder) error

Encode encodes multiple serializer objects at once. If an error occurs, the index at which it occurred is also reported.

Types

type Decoder

type Decoder interface {
	// Decode reads an object from a stream.
	// If the stream fails, the underlying error is returned.
	Decode(io.Reader) error
}

A Decoder can decode itself from a stream.

type Encoder

type Encoder interface {
	// Encode writes itself to a stream.
	// If the stream fails, the underlying error is returned.
	Encode(io.Writer) error
}

An Encoder can encode itself into a stream.

type Serializer

type Serializer interface {
	Encoder
	Decoder
}

Serializer objects can be serialized into and from streams.