https://github.com/traviskaufman/serde_bencode

Bencode serialization / deserialization for rust, powered by serde
https://github.com/traviskaufman/serde_bencode

Last synced: 7 days ago
JSON representation

Bencode serialization / deserialization for rust, powered by serde

• Host: GitHub
• URL: https://github.com/traviskaufman/serde_bencode
• Owner: traviskaufman
• License: mit
• Created: 2016-10-03T03:47:34.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2016-10-17T01:02:29.000Z (over 8 years ago)
• Last Synced: 2025-01-08T15:53:39.645Z (16 days ago)
• Language: Rust
• Homepage:
• Size: 21.5 KB
• Stars: 2
• Watchers: 4
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Bencode

[![Build Status](https://travis-ci.org/traviskaufman/serde_bencode.svg?branch=master)](https://travis-ci.org/traviskaufman/serde_bencode)

A [bencode](https://en.wikipedia.org/wiki/Bencode) serialization/deserialization library for Rust using

[serde](https://serde.rs/).

> Status: Work in Progress. Check out the [1.0.0 Milestone](https://github.com/traviskaufman/bencode-rs/milestone/1)!

## Usage

```rust

extern crate serde;

extern crate serde_bencode;

#[derive(Serialize, Deserialize, Debug)]

struct Point {

    x: i32,

    y: i32

}

#[derive(Serialize, Deserialize, Debug)]

struct Complex {

    s: String,

    i: i32,

    v: Vec

}

// main.rs

fn main() {

    let c = Complex {

        s: "Hello, World!".to_string(),

        i: 42,

        v: vec![Point{ x: 1, y: 2}, Point{ x: 4, y: 7}, Point{ x: 8, y: 19 }]

    };

    println!("original = {:?}", c);

    let serialized = serde_bencode::to_string(&c).unwrap();

    println!("serialized = {}", serialized);

    let deserialized: Complex = serde_bencode::from_string(serialized).unwrap();

    println!("deserialized = {:?}", deserialized);

}

```

Prints:

```

original = Complex { s: "Hello, World!", i: 42, v: [Point { x: 1, y: 2 }, Point { x: 4, y: 7 }, Point { x: 8, y: 19 }] }

serialized = d1:ii42e1:s13:Hello, World!1:vld1:xi1e1:yi2eed1:xi4e1:yi7eed1:xi8e1:yi19eeee

deserialized = Complex { s: "Hello, World!", i: 42, v: [Point { x: 1, y: 2 }, Point { x: 4, y: 7 }, Point { x: 8, y: 19 }] }

```

Cargo installation, API docs, and actual usage coming soon!

This implementation borrows very heavily from [serde_json](https://github.com/serde-rs/json), which was used as a

model for how to build this serializer. Some ideas, like `Read`, were lifted directly from that code.