Merge #180: feat!: Change ConfigBuilder::timeout to accept Option<Duration>

5dc4bb6 ci: bump clippy to 1.90.0 (valued mammal)
e31cf47 feat!: Change ConfigBuilder::timeout to accept Option<Duration> (valued mammal)

Pull request description:

  Change `ConfigBuilder::timeout` to accept `Option<Duration>`. This makes the API more explicit and less error prone, as the caller no longer needs to assume the units of the given duration.

  Also updated the code to run clippy check in CI using rust 1.90.0.

  BREAKING:

  The `timeout` method on `ConfigBuilder` is changed to accept a `timeout: Option<Duration>`. Previously it was `Option<u8>`.

  fix #151
  fix #175
  Supersedes #179

ACKs for top commit:
  oleonardolima:
    ACK 5dc4bb6

Tree-SHA512: cd6ca6fdd91dcf6f193327ca40f6d37ea8b1b548102f080d0b72a0df509f6455aa50ee43148e4746ca6b295a30a78cb7d786fb0e90c050448e96e122a5b8c92d

Author: ValuedMammal

.github/workflows/cont_integration.yml

@@ -62,13 +62,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: dtolnay/rust-toolchain@stable
+      - uses: dtolnay/rust-toolchain@v1
         with:
-          toolchain: 1.84.0
+          toolchain: 1.90.0
           components: clippy
       - name: Rust Cache
         uses: Swatinem/[email protected]
-      - uses: actions-rs/clippy-check@v1
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          args: --all-features --all-targets -- -D warnings
+      - run: cargo clippy --all-features --all-targets -- -D warnings

src/batch.rs

@@ -88,7 +88,7 @@ impl Batch {
     }
 
     /// Returns an iterator on the batch
-    pub fn iter(&self) -> BatchIter {
+    pub fn iter(&self) -> BatchIter<'_> {
         BatchIter {
             batch: self,
             index: 0,

src/client.rs

@@ -448,7 +448,9 @@ mod tests {
         let now = Instant::now();
         let client = Client::from_config(
             &endpoint,
-            crate::config::ConfigBuilder::new().timeout(Some(5)).build(),
+            crate::config::ConfigBuilder::new()
+                .timeout(Some(Duration::from_secs(5)))
+                .build(),
         );
         let elapsed = now.elapsed();
 

src/config.rs

@@ -55,8 +55,8 @@ impl ConfigBuilder {
     }
 
     /// Sets the timeout
-    pub fn timeout(mut self, timeout: Option<u8>) -> Self {
-        self.config.timeout = timeout.map(|t| Duration::from_secs(t as u64));
+    pub fn timeout(mut self, timeout: Option<Duration>) -> Self {
+        self.config.timeout = timeout;
         self
     }
 

src/socks/v4.rs

@@ -18,12 +18,7 @@ fn read_response(socket: &mut TcpStream) -> io::Result<SocketAddrV4> {
 
     match response.read_u8()? {
         90 => {}
-        91 => {
-            return Err(io::Error::new(
-                io::ErrorKind::Other,
-                "request rejected or failed",
-            ))
-        }
+        91 => return Err(io::Error::other("request rejected or failed")),
         92 => {
             return Err(io::Error::new(
                 io::ErrorKind::PermissionDenied,

src/socks/v5.rs

@@ -37,10 +37,7 @@ fn read_addr<R: Read>(socket: &mut R) -> io::Result<TargetAddr> {
                 ip, port, 0, 0,
             ))))
         }
-        _ => Err(io::Error::new(
-            io::ErrorKind::Other,
-            "unsupported address type",
-        )),
+        _ => Err(io::Error::other("unsupported address type")),
     }
 }
 
@@ -54,35 +51,15 @@ fn read_response(socket: &mut TcpStream) -> io::Result<TargetAddr> {
 
     match socket.read_u8()? {
         0 => {}
-        1 => {
-            return Err(io::Error::new(
-                io::ErrorKind::Other,
-                "general SOCKS server failure",
-            ))
-        }
-        2 => {
-            return Err(io::Error::new(
-                io::ErrorKind::Other,
-                "connection not allowed by ruleset",
-            ))
-        }
-        3 => return Err(io::Error::new(io::ErrorKind::Other, "network unreachable")),
-        4 => return Err(io::Error::new(io::ErrorKind::Other, "host unreachable")),
-        5 => return Err(io::Error::new(io::ErrorKind::Other, "connection refused")),
-        6 => return Err(io::Error::new(io::ErrorKind::Other, "TTL expired")),
-        7 => {
-            return Err(io::Error::new(
-                io::ErrorKind::Other,
-                "command not supported",
-            ))
-        }
-        8 => {
-            return Err(io::Error::new(
-                io::ErrorKind::Other,
-                "address kind not supported",
-            ))
-        }
-        _ => return Err(io::Error::new(io::ErrorKind::Other, "unknown error")),
+        1 => return Err(io::Error::other("general SOCKS server failure")),
+        2 => return Err(io::Error::other("connection not allowed by ruleset")),
+        3 => return Err(io::Error::other("network unreachable")),
+        4 => return Err(io::Error::other("host unreachable")),
+        5 => return Err(io::Error::other("connection refused")),
+        6 => return Err(io::Error::other("TTL expired")),
+        7 => return Err(io::Error::other("command not supported")),
+        8 => return Err(io::Error::other("address kind not supported")),
+        _ => return Err(io::Error::other("unknown error")),
     }
 
     if socket.read_u8()? != 0 {
@@ -227,14 +204,11 @@ impl Socks5Stream {
         }
 
         if selected_method == 0xff {
-            return Err(io::Error::new(
-                io::ErrorKind::Other,
-                "no acceptable auth methods",
-            ));
+            return Err(io::Error::other("no acceptable auth methods"));
         }
 
         if selected_method != auth.id() && selected_method != Authentication::None.id() {
-            return Err(io::Error::new(io::ErrorKind::Other, "unknown auth method"));
+            return Err(io::Error::other("unknown auth method"));
         }
 
         match *auth {