Crate error_tools

Module :: error_tools

Basic exceptions handling mechanism.

Basic use-case

#[ cfg( feature = "enabled" ) ]
fn main()
{
  let err = f1();
  println!( "{err:#?}" );
  // < Err(
  // <    BasicError {
  // <        msg: "Some error",
  // <    },
  // < )
}

#[ cfg( feature = "enabled" ) ]
fn f1() -> error_tools::Result< () >
{
  let _read = std::fs::read_to_string( "Cargo.toml" )?;
  Err( error_tools::BasicError::new( "Some error" ).into() )
}

To add to your project

cargo add error_tools

Try out from the repository

git clone https://github.com/Wandalen/wTools
cd wTools
cargo run --example error_tools_trivial

Modules

• assert
  Assertions.
• dependency
  Namespace with dependencies.
• error
  Alias for std::error::BasicError.
• exposed
  Exposed namespace of the module.
• for_app
  Exceptions handling mechanism for apps.
• for_lib
  Exceptions handling mechanism for libs.
• orphan
  Shared with parent namespace of the module
• prelude
  Prelude to use essentials: use my_module::prelude::*.
• protected
  Protected namespace of the module.

Macros

• debug_assert_id
  Macro asserts that two expressions are identical to each other. Unlike std::assert_eq it is removed from a release build.
• debug_assert_identical
  Macro asserts that two expressions are identical to each other. Unlike std::assert_eq it is removed from a release build. Alias of debug_assert_id.
• debug_assert_ni
  Macro asserts that two expressions are not identical to each other. Unlike std::assert_eq it is removed from a release build.
• debug_assert_not_identical
  Macro asserts that two expressions are not identical to each other. Unlike std::assert_eq it is removed from a release build.
• err
  Macro to generate an error descriptor.
• return_err
  Macro to return an Err( error ) generating error descriptor.

Structs

• BasicError
  baic implementation of generic BasicError

Traits

• ErrorInterface
  Error is a trait representing the basic expectations for error values, i.e., values of type E in Result<T, E>.

Type Aliases

• Result
  Result<T, Error>