Bencode

version 1.0.0

---

A Swift Bencode encoder/decoder library intended for use with native macOS torrent clients or *nix trackers, written in async Swift 6.

Inspired by the very excellent danieltmbr/Bencode.

Prerequisites

• Swift 6.2
• Xcode 26

Installation

Swift Package Manager

Add dependency to your Package.swift Package declaration e.g.:

dependencies: [
    .package(url: "https://github.com/avcloudy/Bencode.git", from: "1.0.0")
],

Add it as a target to the specific target/s:

targets: [
        .target(
            name: "Bencode"
            dependencies: [
                .product(name: "Bencode", package: "Bencode")
            ]
        ),
    ...

Build your package or run swift package resolve.

Xcode

In Xcode go to File > Add Package Dependencies and enter the url of this repository (https://github.com/avcloudy/Bencode.git).

Usage

import Bencode at the top of every file where you use it.

Initialise a Bencode object from a file:

let url = URL(fileURLWithPath: "path/to/file.torrent")
let bencode: Bencode? = try await Bencode(file: url)

Initialise a Bencode object from a string:

let string = "17:This is a string!"
let bencode: Bencode? = try Bencode(bencodedString: string)

Initialise a Bencode object from a stream of bytes:

let bytes = Data("17:This is a string!".utf8)
let bencode: Bencode? = try Bencode(data: bytes)

Access parts of Bencode objects

let announceList = metadata["announce-list"]
let firstAnnounce = announceList?[0]

Hash a Bencode object:

guard let infoDict = bencode["info"] else { Error }
let hash: String = infoDict.hexHashed

Build manual Bencode objects

let one = Bencode.string(Data("One".utf8))
let two = Bencode.int(2)
let three = Bencode.list(.string(one, two))
let dict = Bencode.dict([
    Data("string".utf8): one,
    Data("int".utf8): two
    Data("list".utf8): three
])

Build a bencoded stream of bytes from a Bencode object:

let bytes: Data = bencode.encoded

Type safe error handling:

do {
    let bencodeDict = try Bencode(bencodedString: testString)
} catch BencodeError.badKey {
    print("That isn't a valid dictionary key.")
} catch let error as BencodeError {
    print("An error occurred during Bencode parsing: /(error)")
}

Note, any async functions may throw errors related to async handling. Bencode(file:) is async, and you must provide a default catch case.

Help

• Post issues or contact me directly
• Feel free to request features!

License

Licensed under the MIT License, see LICENSE for more details.