Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cristalhq/bencode
Bencode encoding and decoding in Go.
https://github.com/cristalhq/bencode
bencode bencode-parser codec decoder dependency-free deserialization encoder go golang serialization
Last synced: about 2 months ago
JSON representation
Bencode encoding and decoding in Go.
- Host: GitHub
- URL: https://github.com/cristalhq/bencode
- Owner: cristalhq
- License: mit
- Created: 2019-06-21T18:21:45.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-03-08T10:29:11.000Z (10 months ago)
- Last Synced: 2024-04-30T07:19:33.457Z (8 months ago)
- Topics: bencode, bencode-parser, codec, decoder, dependency-free, deserialization, encoder, go, golang, serialization
- Language: Go
- Homepage:
- Size: 58.6 KB
- Stars: 10
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# bencode
[![build-img]][build-url]
[![pkg-img]][pkg-url]
[![version-img]][version-url]
Package implements Bencode encoding and decoding in Go.
## Features
* Simple API.
* Clean and tested code.
* Optimized for speed.
* Dependency-free.
See [docs][pkg-url].
## Install
Go version 1.18+
```
go get github.com/cristalhq/bencode
```
## Example
Marshaling into Bencode
```go
// data to process, most of the types are supported
var data any = map[string]any{
"1": 42,
"hello": "world",
"foo": []string{"bar", "baz"},
}
buf, err := bencode.Marshal(data)
checkErr(err)
fmt.Printf("marshaled: %s\n", string(buf))
// or via Encoder:
w := &bytes.Buffer{} // or any other io.Writer
err = bencode.NewEncoder(w).Encode(data)
checkErr(err)
// Output:
// marshaled: d1:1i42e3:fool3:bar3:baze5:hello5:worlde
```
Unmarshaling from Bencode
```go
var data any
buf := []byte("li1ei42ee")
err := bencode.Unmarshal(buf, &data)
checkErr(err)
// or via Decoder:
r := bytes.NewBufferString("li1ei42ee") // or any other io.Reader
err = bencode.NewDecoder(r).Decode(&data)
checkErr(err)
fmt.Printf("unmarshaled: %v\n", data)
// Output:
// unmarshaled: [1 42]
```
See examples: [example_test.go](example_test.go).
## License
[MIT License](LICENSE).
[build-img]: https://github.com/cristalhq/bencode/workflows/build/badge.svg
[build-url]: https://github.com/cristalhq/bencode/actions
[pkg-img]: https://pkg.go.dev/badge/cristalhq/bencode
[pkg-url]: https://pkg.go.dev/github.com/cristalhq/bencode
[version-img]: https://img.shields.io/github/v/release/cristalhq/bencode
[version-url]: https://github.com/cristalhq/bencode/releases