ogórek

README

ogórek

ogórek is a Go library for encoding and decoding pickles.

Fuzz Testing

Fuzz testing has been implemented for the decoder. To run fuzz tests do the following:

go get github.com/dvyukov/go-fuzz/go-fuzz
go get github.com/dvyukov/go-fuzz/go-fuzz-build
go-fuzz-build github.com/kisielk/og-rek
go-fuzz -bin=./ogórek-fuzz.zip -workdir=./fuzz

Documentation

Overview

Package ogórek is a library for decoding Python's pickle format.

ogórek is Polish for "pickle".

Index

• Variables
• type Call
• type Class
• type Decoder
  • func NewDecoder(r io.Reader) *Decoder
  • func (d *Decoder) Decode() (interface{}, error)
• type Encoder
  • func NewEncoder(w io.Writer) *Encoder
  • func (e *Encoder) Encode(v interface{}) error
• type Marshaler
• type None
• type OpcodeError
  • func (e OpcodeError) Error() string
• type Tuple
• type TypeError
  • func (te *TypeError) Error() string

Variables

var ErrInvalidPickleVersion = errors.New("invalid pickle version")

Types

type Call

type Call struct {
	Callable Class
	Args     Tuple
}

type Class

type Class struct {
	Module, Name string
}

type Decoder

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

Decoder is a decoder for pickle streams.

func NewDecoder

func NewDecoder(r io.Reader) *Decoder

NewDecoder constructs a new Decoder which will decode the pickle stream in r.

func (*Decoder) Decode

func (d *Decoder) Decode() (interface{}, error)

Decode decodes the pickle stream and returns the result or an error.

type Encoder

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

An Encoder encodes Go data structures into pickle byte stream

func NewEncoder

func NewEncoder(w io.Writer) *Encoder

NewEncoder returns a new Encoder struct with default values

func (*Encoder) Encode

func (e *Encoder) Encode(v interface{}) error

Encode writes the pickle encoding of v to w, the encoder's writer

type Marshaler

type Marshaler interface {
	MarshalPickle() (text []byte, err error)
}

Marshaler is the interface implemented by an object that can marshal itself into a binary form.

type None

type None struct{}

None is a representation of Python's None.

type OpcodeError

type OpcodeError struct {
	Key byte
	Pos int
}

func (OpcodeError) Error

func (e OpcodeError) Error() string

type Tuple

type Tuple []interface{}

Tuple is a representation of Python's tuple.

type TypeError

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

func (*TypeError) Error

func (te *TypeError) Error() string