torrust-actix 4.1.2

A rich, fast and efficient Bittorrent Tracker.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

//! Individual peer information for a torrent.

use std::net::SocketAddr;
use serde::Serialize;
use crate::common::structs::number_of_bytes::NumberOfBytes;
use crate::common::structs::number_of_bytes_def::NumberOfBytesDef;
use crate::tracker::enums::announce_event::AnnounceEvent;
use crate::tracker::enums::announce_event_def::AnnounceEventDef;
use crate::tracker::structs::peer_id::PeerId;

/// Information about a single peer participating in a torrent swarm.
///
/// Each `TorrentPeer` represents a BitTorrent client that has announced to the tracker.
/// It contains the peer's identification, network address, transfer statistics, and
/// the most recent announce event.
///
/// # Peer Classification
///
/// A peer is classified as a seed or leech based on the `left` field:
/// - `left == 0`: The peer is a seed (has complete copy)
/// - `left > 0`: The peer is a leech (still downloading)
///
/// # Example
///
/// ```rust,ignore
/// use torrust_actix::tracker::structs::torrent_peer::TorrentPeer;
///
/// // Check if peer is a seed
/// let is_seed = peer.left.0 == 0;
///
/// // Get peer address for compact response
/// let addr = peer.peer_addr;
/// ```
#[derive(PartialEq, Eq, Debug, Clone, Serialize)]
pub struct TorrentPeer {
    /// The unique peer identifier provided by the client.
    pub peer_id: PeerId,

    /// The network address (IP and port) where the peer can be reached.
    pub peer_addr: SocketAddr,

    /// Timestamp of the last announce from this peer.
    ///
    /// Used for peer timeout/cleanup calculations.
    #[serde(with = "serde_millis")]
    pub updated: std::time::Instant,

    /// Total bytes uploaded by this peer for this torrent.
    #[serde(with = "NumberOfBytesDef")]
    pub uploaded: NumberOfBytes,

    /// Total bytes downloaded by this peer for this torrent.
    #[serde(with = "NumberOfBytesDef")]
    pub downloaded: NumberOfBytes,

    /// Bytes remaining to download (0 = complete/seed).
    #[serde(with = "NumberOfBytesDef")]
    pub left: NumberOfBytes,

    /// The most recent announce event from this peer.
    #[serde(with = "AnnounceEventDef")]
    pub event: AnnounceEvent,
}