bencode

Documentation

Overview

Package bencode implements bencoding of data as defined in BEP 3 using type assertion over reflection for performance.

Index

• func Marshal(v interface{}) ([]byte, error)
• func Unmarshal(buf []byte) (interface{}, error)
• type Decoder
  • func NewDecoder(r io.Reader) *Decoder
  • func (dec *Decoder) Decode() (interface{}, error)
• type Dict
  • func NewDict() Dict
  • func (d Dict) MarshalBencode() ([]byte, error)
• type Encoder
  • func NewEncoder(w io.Writer) *Encoder
  • func (enc *Encoder) Encode(v interface{}) error
• type List
  • func NewList() List
  • func (l List) MarshalBencode() ([]byte, error)
• type Marshaler

Functions

func Marshal

func Marshal(v interface{}) ([]byte, error)

Marshal returns the bencoding of v.

func Unmarshal

func Unmarshal(buf []byte) (interface{}, error)

Unmarshal deserializes and returns the bencoded value in buf.

Types

type Decoder

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

A Decoder reads bencoded objects from an input stream.

func NewDecoder

func NewDecoder(r io.Reader) *Decoder

NewDecoder returns a new decoder that reads from r.

func (*Decoder) Decode

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

Decode unmarshals the next bencoded value in the stream.

type Dict

type Dict map[string]interface{}

Dict represents a bencode dictionary.

func NewDict

func NewDict() Dict

NewDict allocates the memory for a Dict.

func (Dict) MarshalBencode

func (d Dict) MarshalBencode() ([]byte, error)

MarshalBencode implements the Marshaler interface for Dict.

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 (enc *Encoder) Encode(v interface{}) error

Encode writes the bencoding of v to the stream.

type List

type List []interface{}

List represents a bencode list.

func NewList

func NewList() List

NewList allocates the memory for a List.

func (List) MarshalBencode

func (l List) MarshalBencode() ([]byte, error)

MarshalBencode implements the Marshaler interface for List.

type Marshaler

type Marshaler interface {
	MarshalBencode() ([]byte, error)
}

Marshaler is the interface implemented by objects that can marshal themselves.