Fix URLs in doc

Author: ssrlive

README.md

@@ -22,7 +22,7 @@ This repo hosts at [socks5-impl](https://github.com/ssrlive/socks5-impl/tree/mas
 
 ## Usage
 
-The entry point of this crate is [`socks5_impl::server::Server`](https://docs.rs/socks5-impl/latest/socks5_impl/server/struct.Server.html).
+The entry point of this crate is [`socks5_impl::server::Server`](crate::server::Server).
 
 Check [examples](https://github.com/ssrlive/socks5-impl/tree/master/examples) for usage examples.
 

src/server/auth.rs

@@ -6,7 +6,7 @@ use tokio::net::TcpStream;
 
 /// This trait is for defining the socks5 authentication method.
 ///
-/// Pre-defined authentication methods can be found in the [`auth`](https://docs.rs/socks5-impl/latest/socks5_impl/server/auth/index.html) module.
+/// Pre-defined authentication methods can be found in the [`auth`](crate::server::auth) module.
 ///
 /// You can create your own authentication method by implementing this trait. Since GAT is not stabled yet,
 /// [async_trait](https://docs.rs/async-trait/latest/async_trait/index.html) needs to be used.

src/server/connection/associate.rs

@@ -57,8 +57,7 @@ impl<S: Default> UdpAssociate<S> {
 
     /// Reads the linger duration for this socket by getting the `SO_LINGER` option.
     ///
-    /// For more information about this option, see
-    /// [set_linger](https://docs.rs/socks5-impl/latest/socks5_impl/server/connection/struct.Connect.html#method.set_linger).
+    /// For more information about this option, see [`set_linger`](#method.set_linger).
     #[inline]
     pub fn linger(&self) -> std::io::Result<Option<Duration>> {
         self.stream.linger()
@@ -78,8 +77,7 @@ impl<S: Default> UdpAssociate<S> {
 
     /// Gets the value of the `TCP_NODELAY` option on this socket.
     ///
-    /// For more information about this option, see
-    /// [set_nodelay](https://docs.rs/socks5-impl/latest/socks5_impl/server/connection/struct.Connect.html#method.set_nodelay).
+    /// For more information about this option, see [`set_nodelay`](#method.set_nodelay).
     #[inline]
     pub fn nodelay(&self) -> std::io::Result<bool> {
         self.stream.nodelay()
@@ -96,8 +94,7 @@ impl<S: Default> UdpAssociate<S> {
 
     /// Gets the value of the `IP_TTL` option for this socket.
     ///
-    /// For more information about this option, see
-    /// [set_ttl](https://docs.rs/socks5-impl/latest/socks5_impl/server/connection/struct.Connect.html#method.set_ttl).
+    /// For more information about this option, see [`set_ttl`](#method.set_ttl).
     pub fn ttl(&self) -> std::io::Result<u32> {
         self.stream.ttl()
     }
@@ -191,8 +188,7 @@ impl<S> From<UdpAssociate<S>> for TcpStream {
 ///
 /// This struct can also be revert into a raw tokio UDP socket with [`UdpSocket::from::<AssociatedUdpSocket>()`](#impl-From<AssociatedUdpSocket>).
 ///
-/// [`AssociatedUdpSocket`](https://docs.rs/socks5-impl/latest/socks5_impl/server/connection/associate/struct.AssociatedUdpSocket.html)
-/// can be used as the associated UDP socket.
+/// [`AssociatedUdpSocket`] can be used as the associated UDP socket.
 #[derive(Debug)]
 pub struct AssociatedUdpSocket {
     socket: UdpSocket,

src/server/connection/bind.rs

@@ -16,10 +16,10 @@ use tokio::{
 
 /// Socks5 command type `Bind`
 ///
-/// By [`wait_request()`](https://docs.rs/socks5-impl/latest/socks5_impl/server/connection/struct.Authenticated.html#method.wait_request)
-/// on an [`Authenticated`](https://docs.rs/socks5-impl/latest/socks5_impl/server/connection/struct.Authenticated.html) from SOCKS5 client,
+/// By [`wait_request`](crate::server::connection::Authenticated::wait_request)
+/// on an [`Authenticated`](crate::server::connection::Authenticated) from SOCKS5 client,
 /// you may get a `Bind<NeedFirstReply>`. After replying the client 2 times
-/// using [`reply()`](https://docs.rs/socks5-impl/latest/socks5_impl/server/connection/struct.Bind.html#method.reply),
+/// using [`reply()`](crate::server::connection::Bind::reply),
 /// you will get a `Bind<Ready>`, which can be used as a regular async TCP stream.
 ///
 /// A `Bind<S>` can be converted to a regular tokio [`TcpStream`](https://docs.rs/tokio/latest/tokio/net/struct.TcpStream.html) by using the `From` trait.
@@ -79,8 +79,7 @@ impl Bind<NeedFirstReply> {
 
     /// Reads the linger duration for this socket by getting the `SO_LINGER` option.
     ///
-    /// For more information about this option, see
-    /// [set_linger](https://docs.rs/socks5-impl/latest/socks5_impl/server/connection/struct.Bind.html#method.set_linger).
+    /// For more information about this option, see [`set_linger`](crate::server::connection::Bind::set_linger).
     #[inline]
     pub fn linger(&self) -> std::io::Result<Option<Duration>> {
         self.stream.linger()
@@ -100,8 +99,7 @@ impl Bind<NeedFirstReply> {
 
     /// Gets the value of the `TCP_NODELAY` option on this socket.
     ///
-    /// For more information about this option, see
-    /// [set_nodelay](https://docs.rs/socks5-impl/latest/socks5_impl/server/connection/struct.Bind.html#method.set_nodelay).
+    /// For more information about this option, see [`set_nodelay`](crate::server::connection::Bind::set_nodelay).
     #[inline]
     pub fn nodelay(&self) -> std::io::Result<bool> {
         self.stream.nodelay()
@@ -118,8 +116,7 @@ impl Bind<NeedFirstReply> {
 
     /// Gets the value of the `IP_TTL` option for this socket.
     ///
-    /// For more information about this option, see
-    /// [set_ttl](https://docs.rs/socks5-impl/latest/socks5_impl/server/connection/struct.Bind.html#method.set_ttl).
+    /// For more information about this option, see [`set_ttl`](crate::server::connection::Bind::set_ttl).
     pub fn ttl(&self) -> std::io::Result<u32> {
         self.stream.ttl()
     }
@@ -174,8 +171,7 @@ impl Bind<NeedSecondReply> {
 
     /// Reads the linger duration for this socket by getting the `SO_LINGER` option.
     ///
-    /// For more information about this option, see
-    /// [set_linger](https://docs.rs/socks5-impl/latest/socks5_impl/server/connection/struct.Bind.html#method.set_linger).
+    /// For more information about this option, see [`set_linger`](crate::server::connection::Bind::set_linger).
     #[inline]
     pub fn linger(&self) -> std::io::Result<Option<Duration>> {
         self.stream.linger()
@@ -196,7 +192,7 @@ impl Bind<NeedSecondReply> {
     /// Gets the value of the `TCP_NODELAY` option on this socket.
     ///
     /// For more information about this option, see
-    /// [set_nodelay](https://docs.rs/socks5-impl/latest/socks5_impl/server/connection/struct.Bind.html#method.set_nodelay).
+    /// [`set_nodelay`](crate::server::connection::Bind::set_nodelay).
     #[inline]
     pub fn nodelay(&self) -> std::io::Result<bool> {
         self.stream.nodelay()
@@ -213,8 +209,7 @@ impl Bind<NeedSecondReply> {
 
     /// Gets the value of the `IP_TTL` option for this socket.
     ///
-    /// For more information about this option, see
-    /// [set_ttl](https://docs.rs/socks5-impl/latest/socks5_impl/server/connection/struct.Bind.html#method.set_ttl).
+    /// For more information about this option, see [`set_ttl`](crate::server::connection::Bind::set_ttl).
     pub fn ttl(&self) -> std::io::Result<u32> {
         self.stream.ttl()
     }

src/server/connection/mod.rs

@@ -10,7 +10,7 @@ pub mod associate;
 pub mod bind;
 pub mod connect;
 
-/// An incoming connection. This may not be a valid socks5 connection. You need to call [`handshake()`](#method.handshake)
+/// An incoming connection. This may not be a valid socks5 connection. You need to call [`authenticate()`](#method.authenticate)
 /// to perform the socks5 handshake. It will be converted to a proper socks5 connection after the handshake succeeds.
 pub struct IncomingConnection<O> {
     stream: TcpStream,
@@ -43,8 +43,7 @@ impl<O: 'static> IncomingConnection<O> {
 
     /// Reads the linger duration for this socket by getting the `SO_LINGER` option.
     ///
-    /// For more information about this option, see
-    /// [set_linger](https://docs.rs/socks5-impl/latest/socks5_impl/server/connection/struct.IncomingConnection.html#method.set_linger).
+    /// For more information about this option, see [`set_linger`](crate::server::connection::IncomingConnection::set_linger).
     #[inline]
     pub fn linger(&self) -> std::io::Result<Option<Duration>> {
         self.stream.linger()
@@ -65,7 +64,7 @@ impl<O: 'static> IncomingConnection<O> {
     /// Gets the value of the `TCP_NODELAY` option on this socket.
     ///
     /// For more information about this option, see
-    /// [set_nodelay](https://docs.rs/socks5-impl/latest/socks5_impl/server/connection/struct.IncomingConnection.html#method.set_nodelay).
+    /// [`set_nodelay`](#method.set_nodelay).
     #[inline]
     pub fn nodelay(&self) -> std::io::Result<bool> {
         self.stream.nodelay()
@@ -83,7 +82,7 @@ impl<O: 'static> IncomingConnection<O> {
     /// Gets the value of the `IP_TTL` option for this socket.
     ///
     /// For more information about this option, see
-    /// [set_ttl](https://docs.rs/socks5-impl/latest/socks5_impl/server/connection/struct.IncomingConnection.html#method.set_ttl).
+    /// [`set_ttl`](#method.set_ttl).
     pub fn ttl(&self) -> std::io::Result<u32> {
         self.stream.ttl()
     }
@@ -96,10 +95,10 @@ impl<O: 'static> IncomingConnection<O> {
     }
 
     /// Perform a SOCKS5 authentication handshake using the given
-    /// [`AuthExecutor`](https://docs.rs/socks5-impl/latest/socks5_impl/server/auth/trait.AuthExecutor.html) adapter.
+    /// [`AuthExecutor`](crate::server::auth::AuthExecutor) adapter.
     ///
-    /// If the handshake succeeds, an [`Authenticated`](https://docs.rs/socks5-impl/latest/socks5_impl/server/connection/struct.Authenticated.html)
-    /// alongs with the output of the [`AuthExecutor`](https://docs.rs/socks5-impl/latest/socks5_impl/server/auth/trait.AuthExecutor.html) adapter is returned.
+    /// If the handshake succeeds, an [`Authenticated`]
+    /// alongs with the output of the [`AuthExecutor`](crate::server::auth::AuthExecutor) adapter is returned.
     /// Otherwise, the error and the original [`TcpStream`](https://docs.rs/tokio/latest/tokio/net/struct.TcpStream.html) is returned.
     ///
     /// Note that this method will not implicitly close the connection even if the handshake failed.
@@ -144,7 +143,7 @@ impl<O> From<IncomingConnection<O>> for TcpStream {
 /// A TCP stream that has been authenticated.
 ///
 /// To get the command from the SOCKS5 client, use
-/// [`wait_request`](https://docs.rs/socks5-impl/latest/socks5_impl/server/connection/struct.Authenticated.html#method.wait_request).
+/// [`wait_request`](crate::server::connection::Authenticated::wait_request).
 ///
 /// It can also be converted back into a raw [`tokio::TcpStream`](https://docs.rs/tokio/latest/tokio/net/struct.TcpStream.html) with `From` trait.
 pub struct Authenticated(TcpStream);
@@ -157,8 +156,7 @@ impl Authenticated {
 
     /// Waits the SOCKS5 client to send a request.
     ///
-    /// This method will return a [`Command`](https://docs.rs/socks5-impl/latest/socks5_impl/server/connection/enum.Command.html)
-    /// if the client sends a valid command.
+    /// This method will return a [`Command`] if the client sends a valid command.
     ///
     /// When encountering an error, the stream will be returned alongside the error.
     ///
@@ -197,7 +195,7 @@ impl Authenticated {
     /// Reads the linger duration for this socket by getting the `SO_LINGER` option.
     ///
     /// For more information about this option, see
-    /// [set_linger](https://docs.rs/socks5-impl/latest/socks5_impl/server/connection/struct.Authenticated.html#method.set_linger).
+    /// [`set_linger`](crate::server::connection::Authenticated::set_linger).
     #[inline]
     pub fn linger(&self) -> std::io::Result<Option<Duration>> {
         self.0.linger()
@@ -218,7 +216,7 @@ impl Authenticated {
     /// Gets the value of the `TCP_NODELAY` option on this socket.
     ///
     /// For more information about this option, see
-    /// [set_nodelay](https://docs.rs/socks5-impl/latest/socks5_impl/server/connection/struct.Authenticated.html#method.set_nodelay).
+    /// [`set_nodelay`](crate::server::connection::Authenticated::set_nodelay).
     #[inline]
     pub fn nodelay(&self) -> std::io::Result<bool> {
         self.0.nodelay()
@@ -236,7 +234,7 @@ impl Authenticated {
     /// Gets the value of the `IP_TTL` option for this socket.
     ///
     /// For more information about this option, see
-    /// [set_ttl](https://docs.rs/socks5-impl/latest/socks5_impl/server/connection/struct.Authenticated.html#method.set_ttl).
+    /// [`set_ttl`](crate::server::connection::Authenticated::set_ttl).
     pub fn ttl(&self) -> std::io::Result<u32> {
         self.0.ttl()
     }

src/server/mod.rs

@@ -22,7 +22,7 @@ pub use crate::{
 /// The server can be constructed on a given socket address, or be created on an existing TcpListener.
 ///
 /// The authentication method can be configured with the
-/// [`AuthExecutor`](https://docs.rs/socks5-impl/latest/socks5_impl/server/auth/trait.AuthExecutor.html) trait.
+/// [`AuthExecutor`] trait.
 pub struct Server<O> {
     listener: TcpListener,
     auth: AuthAdaptor<O>,
@@ -49,21 +49,21 @@ impl<O: 'static> Server<O> {
         Ok(Self::new(listener, auth))
     }
 
-    /// Accept an [`IncomingConnection`](https://docs.rs/socks5-impl/latest/socks5_impl/server/connection/struct.IncomingConnection.html).
+    /// Accept an [`IncomingConnection`].
     /// The connection may not be a valid socks5 connection. You need to call
-    /// [`IncomingConnection::handshake()`](https://docs.rs/socks5-impl/latest/socks5_impl/server/connection/struct.IncomingConnection.html#method.handshake)
+    /// [`IncomingConnection::authenticate`](crate::server::connection::IncomingConnection::authenticate)
     /// to hand-shake it into a proper socks5 connection.
     #[inline]
     pub async fn accept(&self) -> std::io::Result<(IncomingConnection<O>, SocketAddr)> {
         let (stream, addr) = self.listener.accept().await?;
         Ok((IncomingConnection::new(stream, self.auth.clone()), addr))
     }
 
-    /// Polls to accept an [`IncomingConnection<O>`](https://docs.rs/socks5-impl/latest/socks5_impl/server/connection/struct.IncomingConnection.html).
+    /// Polls to accept an [`IncomingConnection<O>`](crate::server::connection::IncomingConnection).
     ///
     /// The connection is only a freshly created TCP connection and may not be a valid SOCKS5 connection.
     /// You should call
-    /// [`IncomingConnection::authenticate()`](https://docs.rs/socks5-impl/latest/socks5_impl/server/connection/struct.IncomingConnection.html#method.authenticate)
+    /// [`IncomingConnection::authenticate`](crate::server::connection::IncomingConnection::authenticate)
     /// to perform a SOCKS5 authentication handshake.
     ///
     /// If there is no connection to accept, Poll::Pending is returned and the current task will be notified by a waker.