fix: Add documentation and fix clippy lints

Signed-off-by: Wiktor Kwapisiewicz <[email protected]>

rustainers/src/cmd/mod.rs

@@ -108,7 +108,7 @@ impl<'a> Cmd<'a> {
 }
 
 // Blocking API
-impl<'a> Cmd<'a> {
+impl Cmd<'_> {
     fn output_blocking(&self) -> Result<Output, CommandError> {
         debug!("Running blocking command\n{self}");
         let mut cmd: std::process::Command = std::process::Command::new(self.command);
@@ -141,7 +141,7 @@ impl<'a> Cmd<'a> {
 }
 
 // Async API
-impl<'a> Cmd<'a> {
+impl Cmd<'_> {
     async fn output(&self) -> Result<Output, CommandError> {
         debug!("Running command\n{self}");
         let mut cmd = tokio::process::Command::new(self.command);
@@ -226,7 +226,7 @@ pub(crate) fn escape_arg(arg: &str) -> Cow<'_, str> {
     }
 }
 
-impl<'a> Display for Cmd<'a> {
+impl Display for Cmd<'_> {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         write!(f, "{}", self.command)?;
         for arg in &self.args {

rustainers/src/container/network.rs

@@ -113,7 +113,7 @@ mod serde_ip {
     }
 
     struct IpVisitor;
-    impl<'de> Visitor<'de> for IpVisitor {
+    impl Visitor<'_> for IpVisitor {
         type Value = Ip;
 
         fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {

rustainers/src/id.rs

@@ -110,7 +110,7 @@ mod image_id_serde {
 
     struct IdVisitor;
 
-    impl<'de> Visitor<'de> for IdVisitor {
+    impl Visitor<'_> for IdVisitor {
         type Value = Id;
 
         fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {

rustainers/src/images/minio.rs

@@ -70,19 +70,19 @@ impl Minio {
 impl Minio {
     /// The region
     #[must_use]
-    pub fn region(&self) -> &str {
+    pub fn region(&self) -> &'static str {
         "us-east-1"
     }
 
     /// The access key id
     #[must_use]
-    pub fn access_key_id(&self) -> &str {
+    pub fn access_key_id(&self) -> &'static str {
         "minioadmin"
     }
 
     /// The secret access key
     #[must_use]
-    pub fn secret_access_key(&self) -> &str {
+    pub fn secret_access_key(&self) -> &'static str {
         "minioadmin"
     }
 }

rustainers/src/version.rs

@@ -106,7 +106,7 @@ mod serde_version {
 
     struct VersionVisitor;
 
-    impl<'de> Visitor<'de> for VersionVisitor {
+    impl Visitor<'_> for VersionVisitor {
         type Value = Version;
 
         fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {

rustainers/tests/common/images.rs

@@ -1,3 +1,5 @@
+//! Common test images.
+
 use std::net::{IpAddr, Ipv4Addr, SocketAddr};
 use std::process::Command;
 
@@ -7,7 +9,7 @@ use rustainers::{
     RunnableContainerBuilder, ToRunnableContainer, WaitStrategy,
 };
 
-// A web server only accessible when sharing the same network
+/// A web server only accessible when sharing the same network
 #[derive(Debug)]
 pub struct InternalWebServer;
 
@@ -24,9 +26,10 @@ impl ToRunnableContainer for InternalWebServer {
     }
 }
 
-// Curl
+/// Curl image.
 #[derive(Debug)]
 pub struct Curl {
+    /// URL to be checked.
     pub url: String,
 }
 
@@ -57,7 +60,7 @@ impl ToRunnableContainer for Curl {
     }
 }
 
-// A web server accessible from host
+/// A web server accessible from host
 #[derive(Debug)]
 pub struct WebServer(ExposedPort);
 
@@ -78,7 +81,7 @@ impl ToRunnableContainer for WebServer {
 }
 
 impl WebServer {
-    // Container path that contains the static HTML pages
+    /// Container path that contains the static HTML pages
     pub const STATIC_HTML: &'static str = "/usr/share/nginx/html";
 
     /// Get the text content
@@ -95,7 +98,7 @@ impl WebServer {
     }
 }
 
-// Netcat
+/// Netcat
 #[derive(Debug)]
 pub struct Netcat(ExposedPort);
 

rustainers/tests/common/mod.rs

@@ -1,3 +1,5 @@
+//! Common functions.
+
 use rstest::fixture;
 use tracing::{debug, Level};
 use tracing_subscriber::fmt::format::FmtSpan;
@@ -7,6 +9,7 @@ use rustainers::runner::Runner;
 
 pub mod images;
 
+/// Initializes tracing in tests.
 pub fn init_test_tracing(level: Level) {
     tracing_subscriber::fmt()
         .pretty()
@@ -21,7 +24,7 @@ pub fn init_test_tracing(level: Level) {
 
 #[fixture]
 #[once]
-pub fn runner() -> Runner {
+pub(crate) fn runner() -> Runner {
     init_test_tracing(Level::INFO);
 
     let runner = if cfg!(feature = "ensure-podman") {

rustainers/tests/compose_images.rs

@@ -1,3 +1,5 @@
+//! Compose images.
+
 mod common;
 pub use self::common::*;
 

rustainers/tests/custom.rs

@@ -1,3 +1,5 @@
+//! Custom container tests.
+
 use assert2::let_assert;
 use rstest::rstest;
 

rustainers/tests/env.rs

@@ -1,3 +1,5 @@
+//! Envorinment variable tests.
+
 use std::collections::HashMap;
 
 use assert2::check;

rustainers/tests/images.rs

@@ -1,3 +1,5 @@
+//! Contains test images.
+
 #![allow(clippy::expect_used)]
 
 use std::time::SystemTime;

rustainers/tests/network.rs

@@ -1,3 +1,5 @@
+//! Network-related tests.
+
 use assert2::let_assert;
 use rstest::rstest;
 use rustainers::runner::{RunOption, Runner};

rustainers/tests/tools.rs

@@ -1,3 +1,5 @@
+//! Tools for tests.
+
 use assert2::let_assert;
 use rstest::rstest;
 use ulid::Ulid;

rustainers/tests/volume.rs

@@ -1,3 +1,5 @@
+//! Container volume tests.
+
 use assert2::{check, let_assert};
 use rstest::rstest;
 use ulid::Ulid;

rustainers/tests/wait-logs.rs

@@ -1,3 +1,5 @@
+//! Tests for log waits.
+
 use std::time::{Duration, Instant};
 
 use assert2::check;

rustainers/tests/waits.rs

@@ -1,3 +1,5 @@
+//! Tests for waits.
+
 mod common;
 use assert2::let_assert;
 use rstest::rstest;