plain

Documentation

Overview

Package plain provides interfaces and helpers for "plain" encoding.

Plain encodings are intended for human readable data.

Package plain provides interfaces and a few supporting functions for a 'plain' encoding.

A 'plain' encoding should serialize data in a plain text way, without being too 'pretty'.

Index

• func DecodeInt64(r io.Reader, p *int64) error
• func DecodeInt64From(r io.Reader) (int64, error)
• func DecodeJoin(r io.Reader, sep string, ds ...Decoder) error
• func DecodeUint64(r io.Reader, p *uint64) error
• func DecodeUint64From(r io.Reader) (uint64, error)
• func EncodeInt64(w io.Writer, v int64) error
• func EncodeJoin(w io.Writer, sep string, es ...Encoder) error
• func EncodeUint64(w io.Writer, v uint64) error
• func Expect(r io.Reader, s string) error
• func Parse(t Decoder, s string) error
• func Put(w io.Writer, s string) error
• func String(t Encoder) string
• func TestRoundTrip(c Coder, verbose bool) error
• func TestRoundTripClobber(c Coder, clob func(Coder), verbose bool) error
• type Coder
• type Decoder
• type Encoder
• type Int
  • func (i *Int) PlainDecode(r io.Reader) error
  • func (i Int) PlainEncode(w io.Writer) error
• type Uint
  • func (u *Uint) PlainDecode(r io.Reader) error
  • func (u Uint) PlainEncode(w io.Writer) error

Functions

func DecodeInt64

func DecodeInt64(r io.Reader, p *int64) error

func DecodeInt64From

func DecodeInt64From(r io.Reader) (int64, error)

func DecodeJoin

func DecodeJoin(r io.Reader, sep string, ds ...Decoder) error

func DecodeUint64

func DecodeUint64(r io.Reader, p *uint64) error

func DecodeUint64From

func DecodeUint64From(r io.Reader) (uint64, error)

func EncodeInt64

func EncodeInt64(w io.Writer, v int64) error

func EncodeJoin

func EncodeJoin(w io.Writer, sep string, es ...Encoder) error

func EncodeUint64

func EncodeUint64(w io.Writer, v uint64) error

func Expect

func Expect(r io.Reader, s string) error

func Parse

func Parse(t Decoder, s string) error

Parse provides a Parse() function for decoders.

func Put

func Put(w io.Writer, s string) error

func String

func String(t Encoder) string

String provides a String() function for Encoders.

func TestRoundTrip

func TestRoundTrip(c Coder, verbose bool) error

func TestRoundTripClobber

func TestRoundTripClobber(c Coder, clob func(Coder), verbose bool) error

Types

type Coder

type Coder interface {
	Encoder
	Decoder
}

type Decoder

type Decoder interface {
	PlainDecode(io.Reader) error
}

Decoder is the interface for a plain decoder.

type Encoder

type Encoder interface {
	PlainEncode(io.Writer) error
}

Encoder is the interface for a plain encoder.

type Int

type Int int64

func (*Int) PlainDecode

func (i *Int) PlainDecode(r io.Reader) error

func (Int) PlainEncode

func (i Int) PlainEncode(w io.Writer) error

type Uint

type Uint uint64

func (*Uint) PlainDecode

func (u *Uint) PlainDecode(r io.Reader) error

func (Uint) PlainEncode

func (u Uint) PlainEncode(w io.Writer) error