Crate tdyne_peer_id

source ·
Expand description

Base type for BitTorrent peer IDs in Rust

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.

Example:

use tdyne_peer_id::PeerId;
use tdyne_peer_id::errors::BadPeerIdLengthError;

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

Modules

Structs

  • PeerId
    Represents an unparsed peer ID. It’s just a thin wrapper over [u8; 20].