# bencode

**Repository Path**: pub-go/bencode

## Basic Information

- **Project Name**: bencode
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-04-25
- **Last Updated**: 2024-08-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# bencode
a Go implementation of Bencode.

[bep_0003.rst](https://github.com/bittorrent/bittorrent.org/blob/master/beps/bep_0003.rst) | [bep_0003.md(中文)](https://github.com/pub-go/bep/bep_0003.md)

## Usage
```go
import "code.gopub.tech/bencode"

var str = bencode.String("spam")
var data = bencode.Encode(str)   // []byte(`4:spam`)
val, err := bencode.Decode(data) // val==str, err==nil

var i = bencode.Integer(42)
var list = bencode.List{
    bencode.String("item1"),
    bencode.Integer(2),
    bencode.List{},
    bencode.Dict{},
}
var dict = bencode.Dict{
    bencode.String("key-must-be-string"): bencode.String("value can be any bencode.Value"),
}
```

## Implement

### Encode
```go
func Encode(v Value) []byte {
	return v.Encode()
}

type Value interface {
	Encode() []byte
}

type String string
type Integer int64
type List []Value
type Dict map[String]Value

```

### Decode
```go
func Decode(input []byte) (Value, error) {
    ...
}
```