Skip to content

Commit 09add2f

Browse files
committed
fix: docs link errors
1 parent 31344a2 commit 09add2f

File tree

6 files changed

+20
-20
lines changed

6 files changed

+20
-20
lines changed

packages/http-protocol/src/v1/responses/announce.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! `Announce` response for the HTTP tracker [`announce`](crate::servers::http::v1::requests::announce::Announce) request.
1+
//! `Announce` response for the HTTP tracker [`announce`](bittorrent_http_protocol::v1::requests::announce::Announce) request.
22
//!
33
//! Data structures and logic to build the `announce` response.
44
use std::io::Write;

packages/http-protocol/src/v1/responses/scrape.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! `Scrape` response for the HTTP tracker [`scrape`](crate::servers::http::v1::requests::scrape::Scrape) request.
1+
//! `Scrape` response for the HTTP tracker [`scrape`](bittorrent_http_protocol::v1::requests::scrape::Scrape) request.
22
//!
33
//! Data structures and logic to build the `scrape` response.
44
use std::borrow::Cow;

src/servers/http/mod.rs

+13-13
Original file line numberDiff line numberDiff line change
@@ -43,18 +43,18 @@
4343
//!
4444
//! Parameter | Type | Description | Required | Default | Example
4545
//! ---|---|---|---|---|---
46-
//! [`info_hash`](crate::servers::http::v1::requests::announce::Announce::info_hash) | percent encoded of 20-byte array | The `Info Hash` of the torrent. | Yes | No | `%81%00%00%00%00%00%00%00%00%00%00%00%00%00%00%00%00%00%00%00`
46+
//! [`info_hash`](bittorrent_http_protocol::v1::requests::announce::Announce::info_hash) | percent encoded of 20-byte array | The `Info Hash` of the torrent. | Yes | No | `%81%00%00%00%00%00%00%00%00%00%00%00%00%00%00%00%00%00%00%00`
4747
//! `peer_addr` | string |The IP address of the peer. | No | No | `2.137.87.41`
48-
//! [`downloaded`](crate::servers::http::v1::requests::announce::Announce::downloaded) | positive integer |The number of bytes downloaded by the peer. | No | `0` | `0`
49-
//! [`uploaded`](crate::servers::http::v1::requests::announce::Announce::uploaded) | positive integer | The number of bytes uploaded by the peer. | No | `0` | `0`
50-
//! [`peer_id`](crate::servers::http::v1::requests::announce::Announce::peer_id) | percent encoded of 20-byte array | The ID of the peer. | Yes | No | `-qB00000000000000001`
51-
//! [`port`](crate::servers::http::v1::requests::announce::Announce::port) | positive integer | The port used by the peer. | Yes | No | `17548`
52-
//! [`left`](crate::servers::http::v1::requests::announce::Announce::left) | positive integer | The number of bytes pending to download. | No | `0` | `0`
53-
//! [`event`](crate::servers::http::v1::requests::announce::Announce::event) | positive integer | The event that triggered the `Announce` request: `started`, `completed`, `stopped` | No | `None` | `completed`
54-
//! [`compact`](crate::servers::http::v1::requests::announce::Announce::compact) | `0` or `1` | Whether the tracker should return a compact peer list. | No | `None` | `0`
48+
//! [`downloaded`](bittorrent_http_protocol::v1::requests::announce::Announce::downloaded) | positive integer |The number of bytes downloaded by the peer. | No | `0` | `0`
49+
//! [`uploaded`](bittorrent_http_protocol::v1::requests::announce::Announce::uploaded) | positive integer | The number of bytes uploaded by the peer. | No | `0` | `0`
50+
//! [`peer_id`](bittorrent_http_protocol::v1::requests::announce::Announce::peer_id) | percent encoded of 20-byte array | The ID of the peer. | Yes | No | `-qB00000000000000001`
51+
//! [`port`](bittorrent_http_protocol::v1::requests::announce::Announce::port) | positive integer | The port used by the peer. | Yes | No | `17548`
52+
//! [`left`](bittorrent_http_protocol::v1::requests::announce::Announce::left) | positive integer | The number of bytes pending to download. | No | `0` | `0`
53+
//! [`event`](bittorrent_http_protocol::v1::requests::announce::Announce::event) | positive integer | The event that triggered the `Announce` request: `started`, `completed`, `stopped` | No | `None` | `completed`
54+
//! [`compact`](bittorrent_http_protocol::v1::requests::announce::Announce::compact) | `0` or `1` | Whether the tracker should return a compact peer list. | No | `None` | `0`
5555
//! `numwant` | positive integer | **Not implemented**. The maximum number of peers you want in the reply. | No | `50` | `50`
5656
//!
57-
//! Refer to the [`Announce`](crate::servers::http::v1::requests::announce::Announce)
57+
//! Refer to the [`Announce`](bittorrent_http_protocol::v1::requests::announce::Announce)
5858
//! request for more information about the parameters.
5959
//!
6060
//! > **NOTICE**: the [BEP 03](https://www.bittorrent.org/beps/bep_0003.html)
@@ -152,7 +152,7 @@
152152
//! 000000f0: 65 e
153153
//! ```
154154
//!
155-
//! Refer to the [`Normal`](crate::servers::http::v1::responses::announce::Normal), i.e. `Non-Compact`
155+
//! Refer to the [`Normal`](bittorrent_http_protocol::v1::responses::announce::Normal), i.e. `Non-Compact`
156156
//! response for more information about the response.
157157
//!
158158
//! **Sample compact response**
@@ -190,7 +190,7 @@
190190
//! 0000070: 7065 pe
191191
//! ```
192192
//!
193-
//! Refer to the [`Compact`](crate::servers::http::v1::responses::announce::Compact)
193+
//! Refer to the [`Compact`](bittorrent_http_protocol::v1::responses::announce::Compact)
194194
//! response for more information about the response.
195195
//!
196196
//! **Protocol**
@@ -220,12 +220,12 @@
220220
//!
221221
//! Parameter | Type | Description | Required | Default | Example
222222
//! ---|---|---|---|---|---
223-
//! [`info_hash`](crate::servers::http::v1::requests::scrape::Scrape::info_hashes) | percent encoded of 20-byte array | The `Info Hash` of the torrent. | Yes | No | `%81%00%00%00%00%00%00%00%00%00%00%00%00%00%00%00%00%00%00%00`
223+
//! [`info_hash`](bittorrent_http_protocol::v1::requests::scrape::Scrape::info_hashes) | percent encoded of 20-byte array | The `Info Hash` of the torrent. | Yes | No | `%81%00%00%00%00%00%00%00%00%00%00%00%00%00%00%00%00%00%00%00`
224224
//!
225225
//! > **NOTICE**: you can scrape multiple torrents at the same time by passing
226226
//! > multiple `info_hash` parameters.
227227
//!
228-
//! Refer to the [`Scrape`](crate::servers::http::v1::requests::scrape::Scrape)
228+
//! Refer to the [`Scrape`](bittorrent_http_protocol::v1::requests::scrape::Scrape)
229229
//! request for more information about the parameters.
230230
//!
231231
//! **Sample scrape URL**

src/servers/http/v1/extractors/announce_request.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44
//! It parses the query parameters returning an [`Announce`]
55
//! request.
66
//!
7-
//! Refer to [`Announce`](crate::servers::http::v1::requests::announce) for more
7+
//! Refer to [`Announce`](bittorrent_http_protocol::v1::requests::announce) for more
88
//! information about the returned structure.
99
//!
10-
//! It returns a bencoded [`Error`](crate::servers::http::v1::responses::error)
10+
//! It returns a bencoded [`Error`](bittorrent_http_protocol::v1::responses::error)
1111
//! response (`500`) if the query parameters are missing or invalid.
1212
//!
1313
//! **Sample announce request**

src/servers/http/v1/extractors/authentication_key.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
//! It's a wrapper for Axum `Path` extractor in order to return custom
1010
//! authentication errors.
1111
//!
12-
//! It returns a bencoded [`Error`](crate::servers::http::v1::responses::error)
12+
//! It returns a bencoded [`Error`](bittorrent_http_protocol::v1::responses::error)
1313
//! response (`500`) if the `key` parameter are missing or invalid.
1414
//!
1515
//! **Sample authentication error responses**

src/servers/http/v1/extractors/scrape_request.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44
//! It parses the query parameters returning an [`Scrape`]
55
//! request.
66
//!
7-
//! Refer to [`Scrape`](crate::servers::http::v1::requests::scrape) for more
7+
//! Refer to [`Scrape`](bittorrent_http_protocol::v1::requests::scrape) for more
88
//! information about the returned structure.
99
//!
10-
//! It returns a bencoded [`Error`](crate::servers::http::v1::responses::error)
10+
//! It returns a bencoded [`Error`](bittorrent_http_protocol::v1::responses::error)
1111
//! response (`500`) if the query parameters are missing or invalid.
1212
//!
1313
//! **Sample scrape request**

0 commit comments

Comments
 (0)