#bittorrent #peer-id

tdyne-peer-id

Basic Peer ID type used across BitTorrent related libraries

3 stable releases

1.0.2 Oct 6, 2023

#3 in #peer-id

Download history 624/week @ 2024-06-23 1082/week @ 2024-06-30 300/week @ 2024-07-07 204/week @ 2024-07-14 114/week @ 2024-07-21 671/week @ 2024-07-28 316/week @ 2024-08-04 367/week @ 2024-08-11 237/week @ 2024-08-18 102/week @ 2024-08-25 153/week @ 2024-09-01 254/week @ 2024-09-08 15/week @ 2024-09-15 194/week @ 2024-09-22 241/week @ 2024-09-29 32/week @ 2024-10-06

487 downloads per month
Used in 5 crates (2 directly)

MIT/Apache

9KB
87 lines

Base type for BitTorrent peer IDs

tdyne_peer_id is a newtype for BitTorrent peer IDs, represented as [u8; 20]. It's intentionally kept very minimalist to minimise the possibility of backwards-incompatible changes.

[dependencies]
tdyne-peer-id = "1"

Example

use tdyne_peer_id::{PeerId, BadPeerIdLengthError};

fn main() {
    let byte_array: &[u8; 20] = b"-TR0000-*\x00\x01d7xkqq04n";
    let byte_slice: &[u8] = b"-TR0000-*\x00\x01d7xkqq04n";
    let short_byte_slice: &[u8] = b"-TR0000-";

    // creating a PeerId from an array is simple
    let peer_id = PeerId::from(b"-TR0000-*\x00\x01d7xkqq04n");
    assert_eq!(peer_id.to_string(), "-TR0000-???d7xkqq04n".to_string());

    // you can also create PeerId from a byte slice if its 20 bytes long
    _ = PeerId::try_from(byte_slice).expect("matching lengths");

    // …if it's not, you get an error
    let error = BadPeerIdLengthError(short_byte_slice.len());
    assert_eq!(PeerId::try_from(short_byte_slice).expect_err("lengths don't match"), error);
}

Libraries and projects using tdyne_peer_id

tdyne_peer_id is opensourced from TORRENTDYNE, a BitTorrent diagnostic service.

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

No runtime deps