Handshake

Struct Handshake 

Source
pub struct Handshake {
    pub info_hash: [u8; 20],
    pub peer_id: [u8; 20],
    pub reserved: [u8; 8],
}
Expand description

The BitTorrent handshake message.

The handshake is the first message exchanged between peers and includes:

  • Protocol identifier (“BitTorrent protocol”)
  • Reserved bytes (8 bytes, used for capability flags)
  • Info hash (20 bytes, identifies the torrent)
  • Peer ID (20 bytes, identifies the client)

§Reserved Bytes

Bits in the reserved bytes indicate protocol extensions:

  • Byte 5, bit 4: Extension protocol (BEP-10)
  • Byte 7, bit 0: DHT (BEP-5)
  • Byte 7, bit 2: Fast extension (BEP-6)

Fields§

§info_hash: [u8; 20]

The torrent’s info hash.

§peer_id: [u8; 20]

The sender’s peer ID.

§reserved: [u8; 8]

Reserved bytes for protocol extensions.

Implementations§

Source§

impl Handshake

Source

pub fn new(info_hash: [u8; 20], peer_id: [u8; 20]) -> Self

Creates a new handshake with extension protocol and fast extension enabled.

Source

pub fn new_v2(info_hash: [u8; 20], peer_id: [u8; 20]) -> Self

Creates a new handshake with v2 support enabled.

This sets the extension protocol, fast extension, and v2 capability bits.

Source

pub fn supports_extension_protocol(&self) -> bool

Returns true if the peer supports the extension protocol ([BEP-10]).

Source

pub fn supports_fast_extension(&self) -> bool

Returns true if the peer supports the fast extension ([BEP-6]).

Source

pub fn supports_dht(&self) -> bool

Returns true if the peer supports DHT ([BEP-5]).

Source

pub fn supports_v2(&self) -> bool

Returns true if the peer supports BitTorrent v2 ([BEP-52]).

The v2 capability is indicated by the 4th most significant bit in the last byte of the reserved field (bit 4, 0x10).

Source

pub fn set_v2_support(&mut self, enabled: bool)

Sets the v2 support bit in the reserved field.

Source

pub fn encode(&self) -> Bytes

Encodes the handshake to bytes for transmission.

Source

pub fn decode(data: &[u8]) -> Result<Self, PeerError>

Trait Implementations§

Source§

impl Clone for Handshake

Source§

fn clone(&self) -> Handshake

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Handshake

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more