From f185a485f7c7a160f859ce990c2b1b63ec9346c3 Mon Sep 17 00:00:00 2001 From: onalante-msft <89409054+onalante-msft@users.noreply.github.com> Date: Sun, 9 Jan 2022 18:54:54 -0800 Subject: [PATCH 1/2] Add and fix clippy lints and formatting errors --- src/client.rs | 22 +++++++++++++--------- src/lib.rs | 1 + src/server.rs | 7 ++++++- src/uri.rs | 3 +++ 4 files changed, 23 insertions(+), 10 deletions(-) diff --git a/src/client.rs b/src/client.rs index 796cbb8..fe96edb 100644 --- a/src/client.rs +++ b/src/client.rs @@ -6,8 +6,8 @@ use hyper::{ }; use pin_project_lite::pin_project; use std::{ - io, future::Future, + io, path::{Path, PathBuf}, pin::Pin, task::{Context, Poll}, @@ -23,10 +23,7 @@ pin_project! { } impl UnixStream { - async fn connect

(path: P) -> std::io::Result - where - P: AsRef, - { + async fn connect(path: impl AsRef) -> io::Result { let unix_stream = tokio::net::UnixStream::connect(path).await?; Ok(Self { unix_stream }) } @@ -40,9 +37,11 @@ impl tokio::io::AsyncWrite for UnixStream { ) -> Poll> { self.project().unix_stream.poll_write(cx, buf) } + fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { self.project().unix_stream.poll_flush(cx) } + fn poll_shutdown(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { self.project().unix_stream.poll_shutdown(cx) } @@ -80,16 +79,20 @@ impl Unpin for UnixConnector {} impl Service for UnixConnector { type Response = UnixStream; - type Error = std::io::Error; - type Future = Pin> + Send + 'static>>; + type Error = io::Error; + #[allow(clippy::type_complexity)] + type Future = + Pin> + Send + 'static>>; + fn call(&mut self, req: Uri) -> Self::Future { let fut = async move { - let path = parse_socket_path(req)?; + let path = parse_socket_path(&req)?; UnixStream::connect(path).await }; Box::pin(fut) } + fn poll_ready(&mut self, _cx: &mut Context<'_>) -> Poll> { Poll::Ready(Ok(())) } @@ -101,7 +104,7 @@ impl Connection for UnixStream { } } -fn parse_socket_path(uri: Uri) -> Result { +fn parse_socket_path(uri: &Uri) -> Result { if uri.scheme_str() != Some("unix") { return Err(io::Error::new( io::ErrorKind::InvalidInput, @@ -138,6 +141,7 @@ pub trait UnixClientExt { /// /// let client = Client::unix(); /// ``` + #[must_use] fn unix() -> Client { Client::builder().build(UnixConnector) } diff --git a/src/lib.rs b/src/lib.rs index 48c41b4..0a64652 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -4,6 +4,7 @@ rust_2018_idioms, missing_docs )] +#![warn(clippy::all, clippy::pedantic)] //! `hyperlocal` provides [Hyper](http://github.com/hyperium/hyper) bindings //! for [Unix domain sockets](https://github.com/tokio-rs/tokio/tree/master/tokio-net/src/uds/). diff --git a/src/server.rs b/src/server.rs index 6c9630a..c477e17 100644 --- a/src/server.rs +++ b/src/server.rs @@ -25,6 +25,9 @@ pub(crate) mod conn { impl SocketIncoming { /// Creates a new `SocketIncoming` binding to provided socket path. + /// + /// # Errors + /// Refer to [`tokio::net::Listener::bind`](https://docs.rs/tokio/1.15.0/tokio/net/struct.UnixListener.html#method.bind). pub fn bind(path: impl AsRef) -> Result { let listener = UnixListener::bind(path)?; @@ -50,7 +53,8 @@ pub(crate) mod conn { self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll>> { - self.listener.poll_accept(cx)? + self.listener + .poll_accept(cx)? .map(|(conn, _)| Some(Ok(conn))) } } @@ -84,6 +88,7 @@ pub(crate) mod conn { /// ``` pub trait UnixServerExt { /// Convenience method for constructing a Server listening on a Unix socket. + #[allow(clippy::missing_errors_doc)] fn bind_unix(path: impl AsRef) -> Result, io::Error>; } diff --git a/src/uri.rs b/src/uri.rs index 51cc9f8..23fb167 100644 --- a/src/uri.rs +++ b/src/uri.rs @@ -19,6 +19,9 @@ pub struct Uri { impl Uri { /// Create a new `[Uri]` from a socket address and a path + /// + /// # Panics + /// Will panic if path is not absolute and/or a malformed path string. pub fn new(socket: impl AsRef, path: &str) -> Self { let host = hex::encode(socket.as_ref().to_string_lossy().as_bytes()); let host_str = format!("unix://{}:0{}", host, path); From b29beff5a3e2aa6346893343a6c2fb4bf06ed1ca Mon Sep 17 00:00:00 2001 From: onalante-msft <89409054+onalante-msft@users.noreply.github.com> Date: Sun, 9 Jan 2022 19:09:24 -0800 Subject: [PATCH 2/2] Update GitHub workflows to use all features --- .github/workflows/main.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index b8344cb..726ec61 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -85,7 +85,7 @@ jobs: with: rust-version: ${{ matrix.rust }} - name: Test - run: cargo test + run: cargo test --all-features publish-docs: if: github.ref == 'refs/heads/main' @@ -97,7 +97,7 @@ jobs: - uses: actions/checkout@v2 - name: Generate Docs run: | - cargo doc --no-deps + cargo doc --no-deps --all-features echo "" > target/doc/index.html - name: Publish uses: peaceiris/actions-gh-pages@v3 @@ -118,4 +118,4 @@ jobs: shell: bash run: cargo publish --token ${{ env.CRATES_TOKEN }} env: - CRATES_TOKEN: ${{ secrets.CRATES_TOKEN }} \ No newline at end of file + CRATES_TOKEN: ${{ secrets.CRATES_TOKEN }}