bencode

README

bencode

Encoding and decoding of values as defined in BEP 3.

Documentation

Overview

Package bencode implements encoding and decoding of values as defined in BEP 3.

Index

• func Marshal(v any) (string, error)
• func Unmarshal(s string, v any) error
• type Decoder
  • func NewDecoder(r io.Reader) *Decoder
  • func (d *Decoder) Decode(v any) error
• type Encoder
  • func NewEncoder(w io.Writer) *Encoder
  • func (e *Encoder) Encode(v any) error
• type Marshaler
• type SyntaxError
  • func (e *SyntaxError) Error() string
• type UnmarshalTypeError
  • func (e *UnmarshalTypeError) Error() string
• type Unmarshaler
• type UnsupportedTypeError
  • func (e *UnsupportedTypeError) Error() string

Functions

func Marshal

func Marshal(v any) (string, error)

Marshal

func Unmarshal

func Unmarshal(s string, v any) error

Unmarshal

Types

type Decoder

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

Decoder

func NewDecoder

func NewDecoder(r io.Reader) *Decoder

NewDecoder

func (*Decoder) Decode

func (d *Decoder) Decode(v any) error

Decode

type Encoder

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

Encoder

func NewEncoder

func NewEncoder(w io.Writer) *Encoder

NewEncoder

func (*Encoder) Encode

func (e *Encoder) Encode(v any) error

Encode

type Marshaler

type Marshaler interface {
	MarshalBEncoding() (string, error)
}

Marshaler

type SyntaxError

type SyntaxError struct {
	Offset int64 // error occurred after read Offset byts
	// contains filtered or unexported fields
}

A SyntaxError is a description of a bencoding syntax error.

func (*SyntaxError) Error

func (e *SyntaxError) Error() string

type UnmarshalTypeError

type UnmarshalTypeError struct {
	Value string       // description of bencoding value
	Type  reflect.Type // type of Go value if could not be assigned to
}

An UnmarshalTypeError describes a bencoding value that was not appropriate for a value of a specific Go type.

func (*UnmarshalTypeError) Error

func (e *UnmarshalTypeError) Error() string

type Unmarshaler

type Unmarshaler interface {
	UnmarshalBEncoding(string) error
}

Unmarshaler

type UnsupportedTypeError

type UnsupportedTypeError struct {
	Type reflect.Type
}

An UnsupportedTypeError is returned by Marshal when attempting to encode an unsupported value type.

func (*UnsupportedTypeError) Error

func (e *UnsupportedTypeError) Error() string