bencode

README

bencode

Bencode is a library for encoding/decoding bencoded data into Go data structures. The api is designed to be similar to the JSON api in the Go standard library.

Documentation

Documentation at http://zeebo.github.com/bencode or http://godoc.org/github.com/zeebo/bencode

Documentation

Overview

Package bencode implements encoding and decoding of bencoded objects.

It has a similar API to the encoding/json package and many other serialization formats.

Index

• func DecodeBytes(b []byte, val interface{}) error
• func DecodeString(in string, val interface{}) error
• func EncodeBytes(val interface{}) ([]byte, error)
• func EncodeString(val interface{}) (string, error)
• type Decoder
  • func NewDecoder(r io.Reader) *Decoder
  • func (d *Decoder) BytesParsed() int
  • func (d *Decoder) Decode(val interface{}) error
• type Encoder
  • func NewEncoder(w io.Writer) *Encoder
  • func (e *Encoder) Encode(val interface{}) error
• type RawMessage

Examples

• DecodeBytes
• DecodeString
• Decoder.Decode
• EncodeBytes
• EncodeString
• Encoder.Encode

Functions

func DecodeBytes

func DecodeBytes(b []byte, val interface{}) error

DecodeBytes reads the data in b and stores it into the value pointed to by val. Read the docs for Decode for more information.

Example

var torrent interface{}
if err := DecodeBytes([]byte(data), &torrent); err != nil {
	panic(err)
}

func DecodeString

func DecodeString(in string, val interface{}) error

DecodeString reads the data in the string and stores it into the value pointed to by val. Read the docs for Decode for more information.

Example

var torrent interface{}
if err := DecodeString(data, &torrent); err != nil {
	panic(err)
}

func EncodeBytes

func EncodeBytes(val interface{}) ([]byte, error)

EncodeBytes returns the bencoded data of val as a slice of bytes.

Example

var torrent interface{}
data, err := EncodeBytes(torrent)
if err != nil {
	panic(err)
}
fmt.Println(data)

func EncodeString

func EncodeString(val interface{}) (string, error)

EncodeString returns the bencoded data of val as a string.

Example

var torrent interface{}
data, err := EncodeString(torrent)
if err != nil {
	panic(err)
}
fmt.Println(data)

Types

type Decoder

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

A Decoder reads and decodes bencoded data from an input stream.

func NewDecoder

func NewDecoder(r io.Reader) *Decoder

NewDecoder returns a new decoder that reads from r

func (*Decoder) BytesParsed

func (d *Decoder) BytesParsed() int

BytesParsed returns the number of bytes that have actually been parsed

func (*Decoder) Decode

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

Decode reads the bencoded value from its input and stores it in the value pointed to by val. Decode allocates maps/slices as necessary with the following additional rules: To decode a bencoded value into a nil interface value, the type stored in the interface value is one of:

int64 for bencoded integers
string for bencoded strings
[]interface{} for bencoded lists
map[string]interface{} for bencoded dicts

Example

dec := NewDecoder(r)
var torrent struct {
	Announce string
	List     [][]string `bencode:"announce-list"`
}
if err := dec.Decode(&torrent); err != nil {
	panic(err)
}

type Encoder

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

An Encoder writes bencoded objects to an output stream.

func NewEncoder

func NewEncoder(w io.Writer) *Encoder

NewEncoder returns a new encoder that writes to w.

func (*Encoder) Encode

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

Encode writes the bencoded data of val to its output stream. See the documentation for Decode about the conversion of Go values to bencoded data.

Example

var x struct {
	Foo string
	Bar []string `bencode:"name"`
}

enc := NewEncoder(w)
if err := enc.Encode(x); err != nil {
	panic(err)
}

type RawMessage

type RawMessage []byte

RawMessage is a special type that will store the raw bencode data when encoding or decoding.