Move module log_crate to re_export::log

Author: SpriteOvO

spdlog/src/lib.rs

@@ -263,6 +263,7 @@ mod log_crate_proxy;
 mod log_macros;
 mod logger;
 mod periodic_worker;
+pub mod re_export;
 mod record;
 pub mod sink;
 mod source_location;
@@ -682,7 +683,7 @@ pub fn init_env_level_from<K: AsRef<OsStr>>(env_key: K) -> StdResult<bool, EnvLe
 /// For more details, please read documentation of [`log::set_logger`] and
 /// [`LogCrateProxy`].
 #[cfg(feature = "log")]
-pub fn init_log_crate_proxy() -> StdResult<(), log_crate::SetLoggerError> {
+pub fn init_log_crate_proxy() -> StdResult<(), re_export::log::SetLoggerError> {
     log::set_logger(log_crate_proxy())
 }
 

spdlog/src/log_crate_proxy.rs

@@ -1,17 +1,5 @@
 use std::time::SystemTime;
 
-/// Re-export some stuff from `log` crate for convenience.
-///
-/// Users sometimes need these stuff, re-exporting them eliminates the need to
-/// explicitly depend on `log` crate in `Cargo.toml`.
-///
-/// See the documentation of [`LogCrateProxy`].
-#[cfg(feature = "log")] // Intentionally redundant, workaround for defects in nested exports of feature
-                        // `doc_auto_cfg`.
-pub mod log_crate {
-    pub use log::{set_max_level, LevelFilter, SetLoggerError};
-}
-
 use crate::{default_logger, sync::*, Logger, Record};
 
 /// Log crate proxy.
@@ -25,13 +13,13 @@ use crate::{default_logger, sync::*, Logger, Record};
 ///
 /// Note that the `log` crate uses a different log level filter and by default
 /// it rejects all log messages. To make `LogCrateProxy` able to receive log
-/// messages from `log` crate, you may need to call [`log_crate::set_max_level`]
-/// with [`log_crate::LevelFilter`].
+/// messages from `log` crate, you may need to call
+/// [`re_export::log::set_max_level`] with [`re_export::log::LevelFilter`].
 ///
 /// ## Examples
 ///
 /// ```
-/// use spdlog::log_crate as log;
+/// use spdlog::re_export::log;
 ///
 /// # fn main() -> Result<(), log::SetLoggerError> {
 /// spdlog::init_log_crate_proxy()?;
@@ -42,6 +30,8 @@ use crate::{default_logger, sync::*, Logger, Record};
 ///
 /// For more and detailed examples, see [./examples] directory.
 ///
+/// [`re_export::log::set_max_level`]: crate::re_export::log::set_max_level
+/// [`re_export::log::LevelFilter`]: crate::re_export::log::LevelFilter
 /// [./examples]: https://github.com/SpriteOvO/spdlog-rs/tree/main/spdlog/examples
 #[derive(Default)]
 pub struct LogCrateProxy {

spdlog/src/re_export.rs

@@ -0,0 +1,31 @@
+//! Re-exports items from other crates for convenience.
+//!
+//! This module selectively re-exports items from other crates that may be used
+//! by users. This effectively eliminates the hassle of manually adding
+//! dependencies to the user's own `Cargo.toml`.
+//!
+//! Users can still call items from these crates directly, as long as semver
+//! versions of the dependencies are compatible.
+
+/// Items from [`log` crate].
+///
+/// The `log` crate has its own level filter, and logs produced by `log` crate
+/// macros will first be filtered by `log` crate itself (this is not controlled
+/// by `spdlog-rs`). When users enable the `log` crate compatibility layer
+/// proxy, please make sure that `log` crate's own level filter is configured
+/// appropriately so that `spdlog-rs` can receive logs.
+///
+/// - To enable the `log` crate compatibility layer proxy, call
+/// [`spdlog::init_log_crate_proxy`].
+///
+/// - To configure `log` crate's own level filter, call
+///   [`re_export::log::set_max_level`] with [`re_export::log::LevelFilter`].
+///
+/// [`log` crate]: https://docs.rs/log
+/// [`spdlog::init_log_crate_proxy`]: crate::init_log_crate_proxy
+/// [`re_export::log::set_max_level`]: crate::re_export::log::set_max_level
+/// [`re_export::log::LevelFilter`]: crate::re_export::log::LevelFilter
+#[cfg(feature = "log")]
+pub mod log {
+    pub use log::{set_max_level, LevelFilter, SetLoggerError};
+}