fixing cyclic dependency problem

Author: Wandalen

module/core/error_tools/examples/error_tools_trivial.rs

@@ -17,5 +17,5 @@ fn main()
 fn f1() -> error_tools::untyped::Result< () >
 {
   let _read = std::fs::read_to_string( "Cargo.toml" )?;
-  Err( error_tools::BasicError::new( "Some error" ).into() )
+  Err( error_tools::untyped::format_err!( "Some error" ) )
 }

module/core/error_tools/src/error.rs

@@ -96,117 +96,132 @@ mod private
   /// helps in defining such results more concisely.
   pub type ResultWithReport< Report, Error > = Result< Report, ( Report, Error ) >;
 
-  ///
-  /// Macro to generate an error descriptor.
-  ///
-  /// ### Basic use-case.
-  /// ```rust
-  /// # use error_tools::{ BasicError, err };
-  /// fn f1() -> BasicError
-  /// {
-  ///   return err!( "No attr" );
-  /// }
-  /// ```
-  ///
-
-  #[ macro_export ]
-  macro_rules! err
-  {
-
-    ( $msg : expr ) =>
-    {
-      $crate::BasicError::new( $msg ).into()
-    };
-    ( $msg : expr, $( $arg : expr ),+ $(,)? ) =>
-    {
-      $crate::BasicError::new( format!( $msg, $( $arg ),+ ) ).into()
-    };
-
-  }
-
-  ///
-  /// Macro to return an Err( error ) generating error descriptor.
-  ///
-  /// ### Basic use-case.
-  /// ```rust
-  /// # use error_tools::{ BasicError, return_err };
-  /// fn f1() -> Result< (), BasicError >
-  /// {
-  ///   return_err!( "No attr" );
-  /// }
-  /// ```
-  ///
-
-  #[ macro_export ]
-  macro_rules! return_err
-  {
-
-    ( $msg : expr ) =>
-    {
-      return Result::Err( $crate::err!( $msg ) )
-    };
-    ( $msg : expr, $( $arg : expr ),+ $(,)? ) =>
-    {
-      return Result::Err( $crate::err!( $msg, $( $arg ),+ ) )
-    };
-
-  }
-
-  // zzz : review
-
-  /// baic implementation of generic BasicError
-
-  #[ derive( core::fmt::Debug, core::clone::Clone, core::cmp::PartialEq, core::cmp::Eq ) ]
-  pub struct BasicError
-  {
-    msg : String,
-  }
-
-  impl BasicError
-  {
-    /// Constructor expecting message with description.
-    pub fn new< Msg : Into< String > >( msg : Msg ) -> BasicError
-    {
-      BasicError { msg : msg.into() }
-    }
-    /// Message with description getter.
-    pub fn msg( &self ) -> &String
-    {
-      &self.msg
-    }
-  }
+//   ///
+//   /// Macro to generate an error descriptor.
+//   ///
+//   /// ### Basic use-case.
+//   /// ```rust
+//   /// # use error_tools::{ BasicError, err };
+//   /// fn f1() -> BasicError
+//   /// {
+//   ///   return err!( "No attr" );
+//   /// }
+//   /// ```
+//   ///
+//
+//   #[ macro_export ]
+//   macro_rules! err
+//   {
+//
+//     ( $msg : expr ) =>
+//     {
+//       $crate::BasicError::new( $msg ).into()
+//     };
+//     ( $msg : expr, $( $arg : expr ),+ $(,)? ) =>
+//     {
+//       $crate::BasicError::new( format!( $msg, $( $arg ),+ ) ).into()
+//     };
+//
+//   }
+//
+//   ///
+//   /// Macro to return an Err( error ) generating error descriptor.
+//   ///
+//   /// ### Basic use-case.
+//   /// ```rust
+//   /// # use error_tools::{ BasicError, return_err };
+//   /// fn f1() -> Result< (), BasicError >
+//   /// {
+//   ///   return_err!( "No attr" );
+//   /// }
+//   /// ```
+//   ///
+//
+//   #[ macro_export ]
+//   macro_rules! return_err
+//   {
+//
+//     ( $msg : expr ) =>
+//     {
+//       return Result::Err( $crate::err!( $msg ) )
+//     };
+//     ( $msg : expr, $( $arg : expr ),+ $(,)? ) =>
+//     {
+//       return Result::Err( $crate::err!( $msg, $( $arg ),+ ) )
+//     };
+//
+//   }
+//
+//   // zzz : review
+//   // xxx : rid of
+//
+//   /// baic implementation of generic BasicError
+//
+//   #[ derive( core::fmt::Debug, core::clone::Clone, core::cmp::PartialEq, core::cmp::Eq ) ]
+//   pub struct BasicError
+//   {
+//     msg : String,
+//   }
+//
+//   impl BasicError
+//   {
+//     /// Constructor expecting message with description.
+//     pub fn new< Msg : Into< String > >( msg : Msg ) -> BasicError
+//     {
+//       BasicError { msg : msg.into() }
+//     }
+//     /// Message with description getter.
+//     pub fn msg( &self ) -> &String
+//     {
+//       &self.msg
+//     }
+//   }
+//
+//   impl core::fmt::Display for BasicError
+//   {
+//     fn fmt(&self, f: &mut core::fmt::Formatter< '_ >) -> core::fmt::Result
+//     {
+//       write!( f, "{}", self.msg )
+//     }
+//   }
+//
+//   impl ErrorTrait for BasicError
+//   {
+//     fn description( &self ) -> &str
+//     {
+//       &self.msg
+//     }
+//   }
+//
+//   impl< T > From< BasicError > for Result< T, BasicError >
+//   {
+//     /// Returns the argument unchanged.
+//     #[ inline( always ) ]
+//     fn from( src : BasicError ) -> Self
+//     {
+//       Result::Err( src )
+//     }
+//   }
+//
+//   pub use err;
+//   pub use return_err;
 
-  impl core::fmt::Display for BasicError
-  {
-    fn fmt(&self, f: &mut core::fmt::Formatter< '_ >) -> core::fmt::Result
-    {
-      write!( f, "{}", self.msg )
-    }
-  }
-
-  impl ErrorTrait for BasicError
-  {
-    fn description( &self ) -> &str
-    {
-      &self.msg
-    }
-  }
+  // qqq : write standard mod interface without using mod_interface /* aaa : Dmytro : added to each library file */
+}
 
-  impl< T > From< BasicError > for Result< T, BasicError >
-  {
-    /// Returns the argument unchanged.
-    #[ inline( always ) ]
-    fn from( src : BasicError ) -> Self
-    {
-      Result::Err( src )
-    }
-  }
+/// Assertions.
+#[ cfg( feature = "enabled" ) ]
+pub mod assert;
 
-  pub use err;
-  pub use return_err;
+#[ cfg( feature = "enabled" ) ]
+#[ cfg( feature = "error_typed" ) ]
+/// Typed exceptions handling mechanism.
+pub mod typed;
 
-  // qqq : write standard mod interface without using mod_interface /* aaa : Dmytro : added to each library file */
-}
+#[ cfg( feature = "enabled" ) ]
+#[ cfg( feature = "error_untyped" ) ]
+/// Untyped exceptions handling mechanism.
+pub mod untyped;
 
 #[ doc( inline ) ]
 #[ allow( unused_imports ) ]
@@ -217,8 +232,37 @@ pub use own::*;
 pub mod own
 {
   use super::*;
+
   #[ doc( inline ) ]
   pub use orphan::*;
+
+  #[ doc( inline ) ]
+  pub use assert::orphan::*;
+
+  #[ cfg( feature = "error_untyped" ) ]
+  #[ doc( inline ) ]
+  pub use untyped::orphan::*;
+
+  #[ cfg( feature = "error_typed" ) ]
+  #[ doc( inline ) ]
+  pub use typed::orphan::*;
+
+  #[ doc( inline ) ]
+  pub use private::
+  {
+    // err,
+    // return_err,
+    ErrorTrait,
+    // BasicError,
+  };
+
+  pub use super::
+  {
+    assert,
+    typed,
+    untyped,
+  };
+
 }
 
 /// Shared with parent namespace of the module
@@ -236,6 +280,9 @@ pub mod exposed
 {
   use super::*;
 
+  #[ doc( inline ) ]
+  pub use prelude::*;
+
   #[ doc( inline ) ]
   pub use private::
   {
@@ -244,7 +291,16 @@ pub mod exposed
   };
 
   #[ doc( inline ) ]
-  pub use prelude::*;
+  pub use assert::exposed::*;
+
+  #[ cfg( feature = "error_untyped" ) ]
+  #[ doc( inline ) ]
+  pub use untyped::exposed::*;
+
+  #[ cfg( feature = "error_typed" ) ]
+  #[ doc( inline ) ]
+  pub use typed::exposed::*;
+
 }
 
 /// Prelude to use essentials: `use my_module::prelude::*`.
@@ -253,13 +309,24 @@ pub mod prelude
 {
   use super::*;
 
+  // #[ doc( inline ) ]
+  // pub use private::
+  // {
+  //   // err,
+  //   // return_err,
+  //   ErrorTrait,
+  //   // BasicError,
+  // };
+
   #[ doc( inline ) ]
-  pub use private::
-  {
-    err,
-    return_err,
-    ErrorTrait,
-    BasicError,
-  };
+  pub use assert::prelude::*;
+
+  #[ cfg( feature = "error_untyped" ) ]
+  #[ doc( inline ) ]
+  pub use untyped::prelude::*;
+
+  #[ cfg( feature = "error_typed" ) ]
+  #[ doc( inline ) ]
+  pub use typed::prelude::*;
 
 }

module/core/error_tools/src/assert.rs renamed to module/core/error_tools/src/error/assert.rs

@@ -13,6 +13,7 @@ pub use own::*;
 pub mod own
 {
   use super::*;
+
   #[ doc( inline ) ]
   pub use orphan::*;
 
@@ -24,6 +25,10 @@ pub mod own
     Error,
     Ok,
     Result,
+    format_err,
+    bail as return_err,
+    ensure,
+    bail,
   };
 
 }
@@ -39,13 +44,13 @@ pub mod orphan
   #[ doc( inline ) ]
   pub use exposed::*;
 
-  #[ doc( inline ) ]
-  pub use ::anyhow::
-  {
-    format_err,
-    ensure,
-    bail,
-  };
+  // #[ doc( inline ) ]
+  // pub use ::anyhow::
+  // {
+  //   format_err,
+  //   ensure,
+  //   bail,
+  // };
 
 }