doc: added metadata for docs.rs

Cargo.toml

@@ -9,11 +9,12 @@ homepage = "https://github.com/AH-dark/distributed-scheduler"
 authors = ["AH-dark <[email protected]>"]
 readme = "README.md"
 license = "AGPL-3.0-or-later"
-documentation = "https://docs.rs/distributed-scheduler/latest/"
+documentation = "https://docs.rs/distributed-scheduler"
 rust-version = "1.71.0"
+exclude = [".*"]
 
 [package.metadata.docs.rs]
-features = ["full"]
+all-features = true
 
 [features]
 full = ["driver-redis", "driver-etcd"]

src/cron.rs

@@ -8,6 +8,7 @@ use tokio::sync::Mutex;
 use crate::driver::Driver;
 use crate::node_pool;
 
+/// The `Cron` struct is the main entry point for the library, providing the ability to add and remove jobs.
 pub struct Cron<'a, D>
 where
     D: Driver + Send + Sync,
@@ -23,6 +24,7 @@ pub enum Error {
     NodePool(#[from] node_pool::Error),
 }
 
+/// Run the scheduler in a separate task, return a Future
 async fn run_scheduler<'a>(job_scheduler: Arc<Mutex<job_scheduler::JobScheduler<'a>>>) {
     let mut interval = tokio::time::interval(tokio::time::Duration::from_secs(1));
 

src/driver/mod.rs

@@ -1,15 +1,19 @@
 mod utils;
 
 #[cfg(feature = "driver-redis")]
+/// Driver based on Redis Scan
 pub mod redis;
 
 #[cfg(feature = "driver-redis")]
+/// Driver based on Redis ZSet
 pub mod redis_zset;
 
 #[cfg(feature = "driver-etcd")]
+/// Driver based on Etcd
 pub mod etcd;
 
 #[async_trait::async_trait]
+/// The driver trait, which defines the node list management interface.
 pub trait Driver {
     /// Get the local node id.
     fn node_id(&self) -> String;

src/driver/utils.rs

@@ -1,10 +1,12 @@
 pub static GLOBAL_KEY_PREFIX: &str = "distributed-scheduler";
 
+/// Get the key prefix for the given service name.
 pub fn get_key_prefix(service_name: &str) -> String {
     format!("{}:{}:", GLOBAL_KEY_PREFIX, service_name)
 }
 
 #[cfg(feature = "driver-redis")]
+/// Get the zset key for the given service name.
 pub fn get_zset_key(service_name: &str) -> String {
     format!("{}:{}", GLOBAL_KEY_PREFIX, service_name)
 }