refactor: improve logs (#26)

Signed-off-by: tison <[email protected]>

Author: tisonkun

.github/workflows/ci.yml

@@ -53,7 +53,7 @@ jobs:
     strategy:
       matrix:
         os: [ ubuntu-22.04, macos-14, windows-2022 ]
-        rust-version: [ "1.83.0", "stable" ]
+        rust-version: [ "1.85.0", "stable" ]
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v4

Cargo.toml

@@ -22,7 +22,7 @@ homepage = "https://github.com/fast/fastimer"
 license = "Apache-2.0"
 readme = "README.md"
 repository = "https://github.com/fast/fastimer"
-rust-version = "1.83.0"
+rust-version = "1.85.0"
 version = "0.7.0"
 
 [workspace.dependencies]

README.md

@@ -2,14 +2,14 @@
 
 [![Crates.io][crates-badge]][crates-url]
 [![Documentation][docs-badge]][docs-url]
-[![MSRV 1.83][msrv-badge]](https://www.whatrustisit.com)
+[![MSRV 1.85][msrv-badge]](https://www.whatrustisit.com)
 [![Apache 2.0 licensed][license-badge]][license-url]
 [![Build Status][actions-badge]][actions-url]
 
 [crates-badge]: https://img.shields.io/crates/v/fastimer.svg
 [crates-url]: https://crates.io/crates/fastimer
 [docs-badge]: https://docs.rs/fastimer/badge.svg
-[msrv-badge]: https://img.shields.io/badge/MSRV-1.83-green?logo=rust
+[msrv-badge]: https://img.shields.io/badge/MSRV-1.85-green?logo=rust
 [docs-url]: https://docs.rs/fastimer
 [license-badge]: https://img.shields.io/crates/l/fastimer
 [license-url]: LICENSE
@@ -50,7 +50,7 @@ Read the online documents at https://docs.rs/fastimer.
 
 ## Minimum Supported Rust Version (MSRV)
 
-This crate is built against the latest stable release, and its minimum supported rustc version is 1.80.0.
+This crate is built against the latest stable release, and its minimum supported rustc version is 1.85.0.
 
 The policy is that the minimum Rust version required to use this crate can be increased in minor version updates. For example, if Fastimer 1.0 requires Rust 1.20.0, then Fastimer 1.0.z for all values of z will also require Rust 1.20.0 or newer. However, Fastimer 1.y for y > 0 may require a newer minimum version of Rust.
 

fastimer-driver/Cargo.toml

@@ -16,11 +16,11 @@
 name = "fastimer-driver"
 
 description = "This crate implements a timer driver that can work with any async runtime scheduler."
+readme = "README.md"
 
 edition.workspace = true
 homepage.workspace = true
 license.workspace = true
-readme.workspace = true
 repository.workspace = true
 rust-version.workspace = true
 version.workspace = true

fastimer-driver/README.md

@@ -0,0 +1,29 @@
+# Fastimer Driver
+
+[![Crates.io][crates-badge]][crates-url]
+[![Documentation][docs-badge]][docs-url]
+[![MSRV 1.85][msrv-badge]](https://www.whatrustisit.com)
+
+[crates-badge]: https://img.shields.io/crates/v/fastimer-driver.svg
+[crates-url]: https://crates.io/crates/fastimer-driver
+[docs-badge]: https://docs.rs/fastimer-driver/badge.svg
+[msrv-badge]: https://img.shields.io/badge/MSRV-1.85-green?logo=rust
+[docs-url]: https://docs.rs/fastimer-driver
+
+## Overview
+
+This crate implements a timer driver that can work with any async runtime scheduler.
+
+## Documentation
+
+Read the online documents at https://docs.rs/fastimer-driver.
+
+## Minimum Supported Rust Version (MSRV)
+
+This crate is built against the latest stable release, and its minimum supported rustc version is 1.85.0.
+
+The policy is that the minimum Rust version required to use this crate can be increased in minor version updates. For example, if Fastimer 1.0 requires Rust 1.20.0, then Fastimer 1.0.z for all values of z will also require Rust 1.20.0 or newer. However, Fastimer 1.y for y > 0 may require a newer minimum version of Rust.
+
+## License
+
+This project is licensed under [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).

fastimer-tokio/Cargo.toml

@@ -16,11 +16,11 @@
 name = "fastimer-tokio"
 
 description = "This crates provides tokio runtime integration for fastimer."
+readme = "README.md"
 
 edition.workspace = true
 homepage.workspace = true
 license.workspace = true
-readme.workspace = true
 repository.workspace = true
 rust-version.workspace = true
 version.workspace = true

fastimer-tokio/README.md

@@ -0,0 +1,29 @@
+# Fastimer Tokio
+
+[![Crates.io][crates-badge]][crates-url]
+[![Documentation][docs-badge]][docs-url]
+[![MSRV 1.85][msrv-badge]](https://www.whatrustisit.com)
+
+[crates-badge]: https://img.shields.io/crates/v/fastimer-tokio.svg
+[crates-url]: https://crates.io/crates/fastimer-tokio
+[docs-badge]: https://docs.rs/fastimer-tokio/badge.svg
+[msrv-badge]: https://img.shields.io/badge/MSRV-1.85-green?logo=rust
+[docs-url]: https://docs.rs/fastimer-tokio
+
+## Overview
+
+This crates provides tokio runtime integration for fastimer.
+
+## Documentation
+
+Read the online documents at https://docs.rs/fastimer-tokio.
+
+## Minimum Supported Rust Version (MSRV)
+
+This crate is built against the latest stable release, and its minimum supported rustc version is 1.85.0.
+
+The policy is that the minimum Rust version required to use this crate can be increased in minor version updates. For example, if Fastimer 1.0 requires Rust 1.20.0, then Fastimer 1.0.z for all values of z will also require Rust 1.20.0 or newer. However, Fastimer 1.y for y > 0 may require a newer minimum version of Rust.
+
+## License
+
+This project is licensed under [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).

fastimer/src/lib.rs

@@ -43,8 +43,6 @@ use std::future::Future;
 use std::time::Duration;
 use std::time::Instant;
 
-mod macros;
-
 mod interval;
 pub use interval::*;
 
@@ -73,6 +71,8 @@ pub fn make_instant_from_now(dur: Duration) -> Instant {
 }
 
 /// A trait for creating delay futures.
+///
+/// See [`MakeDelayExt`] for extension methods.
 pub trait MakeDelay {
     /// The future returned by the `delay`/`delay_until` method.
     type Delay: Future<Output = ()> + Send;
@@ -126,3 +126,39 @@ pub trait MakeDelayExt: MakeDelay {
 }
 
 impl<T: MakeDelay> MakeDelayExt for T {}
+
+pub(crate) use self::macros::debug;
+pub(crate) use self::macros::info;
+
+#[cfg(feature = "logging")]
+mod macros {
+    macro_rules! debug {
+        (target: $target:expr, $($arg:tt)+) => (log::debug!(target: $target, $($arg)+));
+        ($($arg:tt)+) => (log::debug!($($arg)+));
+    }
+
+    macro_rules! info {
+        (target: $target:expr, $($arg:tt)+) => (log::info!(target: $target, $($arg)+));
+        ($($arg:tt)+) => (log::info!($($arg)+));
+    }
+
+    pub(crate) use debug;
+    pub(crate) use info;
+}
+
+#[cfg(not(feature = "logging"))]
+#[macro_use]
+mod macros {
+    macro_rules! info {
+        (target: $target:expr, $($arg:tt)+) => {};
+        ($($arg:tt)+) => {};
+    }
+
+    macro_rules! debug {
+        (target: $target:expr, $($arg:tt)+) => {};
+        ($($arg:tt)+) => {};
+    }
+
+    pub(crate) use debug;
+    pub(crate) use info;
+}

fastimer/src/macros.rs

@@ -17,6 +17,7 @@ use std::time::Duration;
 use std::time::Instant;
 
 use crate::debug;
+use crate::info;
 use crate::schedule::delay_or_shutdown;
 use crate::schedule::initial_delay_or_shutdown;
 use crate::schedule::BaseAction;
@@ -48,7 +49,7 @@ pub trait ArbitraryDelayActionExt: ArbitraryDelayAction {
         D: MakeDelay + Send + 'static,
     {
         spawn.spawn(async move {
-            debug!(
+            info!(
                 "start scheduled task {} with initial delay {:?}",
                 self.name(),
                 initial_delay

fastimer/src/schedule/arbitrary.rs

@@ -26,7 +26,7 @@ pub use notify::*;
 mod simple;
 pub use simple::*;
 
-use crate::debug;
+use crate::info;
 use crate::MakeDelay;
 
 mod select;
@@ -86,7 +86,7 @@ where
     let is_shutdown = action.is_shutdown();
     match select(is_shutdown, delay).await {
         Either::Left(()) => {
-            debug!("scheduled task {} is stopped", action.name());
+            info!("scheduled task {} is stopped", action.name());
             action.teardown();
             true
         }

fastimer/src/schedule/mod.rs

@@ -16,6 +16,7 @@ use std::future::Future;
 use std::time::Duration;
 
 use crate::debug;
+use crate::info;
 use crate::schedule::initial_delay_or_shutdown;
 use crate::schedule::BaseAction;
 use crate::MakeDelay;
@@ -57,7 +58,7 @@ pub trait NotifyActionExt: NotifyAction {
         D: MakeDelay + Send + 'static,
     {
         spawn.spawn(async move {
-            debug!(
+            info!(
                 "start scheduled task {} with initial delay {:?}",
                 self.name(),
                 initial_delay
@@ -73,7 +74,7 @@ pub trait NotifyActionExt: NotifyAction {
                 self.run().await;
 
                 if self.notified().await {
-                    debug!("scheduled task {} is stopped", self.name());
+                    info!("scheduled task {} is stopped", self.name());
                     self.teardown();
                     return;
                 }

fastimer/src/schedule/notify.rs

@@ -18,6 +18,7 @@ use std::time::Instant;
 
 use crate::debug;
 use crate::far_future;
+use crate::info;
 use crate::make_instant_from;
 use crate::make_instant_from_now;
 use crate::schedule::delay_or_shutdown;
@@ -53,7 +54,7 @@ pub trait SimpleActionExt: SimpleAction {
         D: MakeDelay + Send + 'static,
     {
         spawn.spawn(async move {
-            debug!(
+            info!(
                 "start scheduled task {} with fixed delay {:?} and initial delay {:?}",
                 self.name(),
                 delay,
@@ -129,7 +130,7 @@ pub trait SimpleActionExt: SimpleAction {
         }
 
         spawn.spawn(async move {
-            debug!(
+            info!(
                 "start scheduled task {} at fixed rate {:?} with initial delay {:?}",
                 self.name(),
                 period,