Struct aquatic_ws_protocol::AnnounceRequest

pub struct AnnounceRequest {
    pub action: AnnounceAction,
    pub info_hash: InfoHash,
    pub peer_id: PeerId,
    pub bytes_left: Option<usize>,
    pub event: Option<AnnounceEvent>,
    pub offers: Option<Vec<AnnounceRequestOffer>>,
    pub numwant: Option<usize>,
    pub answer: Option<JsonValue>,
    pub to_peer_id: Option<PeerId>,
    pub offer_id: Option<OfferId>,
}

Fields

action: AnnounceAction

info_hash: InfoHash

peer_id: PeerId

bytes_left: Option<usize>

Just called "left" in protocol. Is set to None in some cases, such as when opening a magnet link

event: Option<AnnounceEvent>

Can be empty. Then, default is "update"

offers: Option<Vec<AnnounceRequestOffer>>

Only when this is an array offers are sent to random peers Length of this is number of peers wanted? Max length of this is 10 in reference client code Not sent when announce event is stopped or completed

numwant: Option<usize>

Seems to only get sent by client when sending offers, and is also same as length of offers vector (or at least never less) Max length of this is 10 in reference client code Could probably be ignored, offers.len() should provide needed info

answer: Option<JsonValue>

If empty, send response before sending offers (or possibly "skip sending update back"?) Else, send MiddlemanAnswerToPeer to peer with "to_peer_id" as peer_id. I think using Option is good, it seems like this isn't always set (same as offers)

to_peer_id: Option<PeerId>

Likely undefined if !(answer == true)

offer_id: Option<OfferId>

Sent if answer is set

Trait Implementations

impl Clone for AnnounceRequest

fn clone(&self) -> AnnounceRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AnnounceRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AnnounceRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for AnnounceRequest

impl PartialEq<AnnounceRequest> for AnnounceRequest

fn eq(&self, other: &AnnounceRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &AnnounceRequest) -> bool

This method tests for !=.

impl Serialize for AnnounceRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for AnnounceRequest

impl StructuralPartialEq for AnnounceRequest