bencode

README

go-bencode

A Go library for handling data in the bencode format. This is the format used by the Mainline DHT and BitTorrent protocols.

Usage

All encoded data objects are []byte. This is the format returned by many network libraries such as UDPConn.Read() etc.

import bencode "src.userspace.com.au/go-bencode"

var i interface{}
var packet []byte
var str string

i, err = bencode.Decode(packet)

// Or if you know the type
str, err = bencode.DecodeString(packet)

// Encoding a string, int, slice or map
packet, err = bencode.Encode(str)

Benchmarks

Just for fun and comparison (go v1.13):

go test -bench=.
goos: freebsd
goarch: amd64
pkg: src.userspace.com.au/go-bencode
BenchmarkFelix-4                  140659              8518 ns/op
BenchmarkMarkSamman-4              72080             16857 ns/op
BenchmarkJackpal-4                 70902             17194 ns/op
BenchmarkDecodeWithString-4      6856792               183 ns/op
BenchmarkDecodeString-4         10423938               130 ns/op
BenchmarkDecodeWithInt-4         8644882               146 ns/op
BenchmarkDecodeInt-4            11680635               107 ns/op
BenchmarkDecodeWithList-4        2046406               527 ns/op
BenchmarkDecodeList-4            2494192               464 ns/op
BenchmarkDecodeWithDict-4        2505790               479 ns/op
BenchmarkDecodeDict-4            2674564               480 ns/op
PASS
ok      src.userspace.com.au/go-bencode 17.455s

Documentation

Index

• func Decode(data []byte) (r interface{}, err error)
• func DecodeDict(data []byte, start int) (map[string]interface{}, int, error)
• func DecodeInt(data []byte, start int) (r int64, end int, err error)
• func DecodeList(data []byte, start int) (r []interface{}, end int, err error)
• func DecodeString(data []byte, start int) (r string, n int, err error)
• func Encode(data interface{}) ([]byte, error)
• func EncodeDict(data map[string]interface{}) ([]byte, error)
• func EncodeInt(data int64) ([]byte, error)
• func EncodeList(data []interface{}) ([]byte, error)
• func EncodeString(data string) ([]byte, error)

Functions

func Decode

func Decode(data []byte) (r interface{}, err error)

Decode decodes a bencoded string to string, int, list or map.

func DecodeDict

func DecodeDict(data []byte, start int) (map[string]interface{}, int, error)

DecodeDict decodes a dict as a map. It returns the map and the number of bytes successfully read.

func DecodeInt

func DecodeInt(data []byte, start int) (r int64, end int, err error)

DecodeInt decodes an integer value. It returns the integer and the number of bytes successfully read.

func DecodeList

func DecodeList(data []byte, start int) (r []interface{}, end int, err error)

DecodeList decodes a list value. It returns the array and the number of bytes successfully read.

func DecodeString

func DecodeString(data []byte, start int) (r string, n int, err error)

DecodeString decodes a string from a given offset. It returns the string, the number of bytes successfully read.

func Encode

func Encode(data interface{}) ([]byte, error)

Encode encodes a string, int, dict or list value to a bencoded string.

func EncodeDict

func EncodeDict(data map[string]interface{}) ([]byte, error)

EncodeDict encodes a dict value.

func EncodeInt

func EncodeInt(data int64) ([]byte, error)

EncodeInt encodes a int value.

func EncodeList

func EncodeList(data []interface{}) ([]byte, error)

EncodeList encodes a list value.

func EncodeString

func EncodeString(data string) ([]byte, error)

EncodeString encodes a string value.