Crate test_tools 

Module :: test_tools

Tools for writing and running tests.

Basic use-case

use test_tools::*;

#[ cfg( feature = "enabled" ) ]
#[ cfg( not( feature = "no_std" ) ) ]
tests_impls!
{
  fn pass1()
  {
    assert_eq!( true, true );
  }

  //

  fn pass2()
  {
    assert_eq!( 1, 1 );
  }
}

//
#[ cfg( feature = "enabled" ) ]
#[ cfg( not( feature = "no_std" ) ) ]
tests_index!
{
  pass1,
  pass2,
}

To add to your project

cargo add test_tools --dev

Try out from the repository

git clone https://github.com/Wandalen/wTools
cd wTools
cd examples/test_trivial
cargo run

Sample

println!("-- doc test: printing Cargo feature environment variables --");
for (key, val) in std::env::vars() {
    if key.starts_with("CARGO_FEATURE_") {
        println!("{}={}", key, val);
    }
}

Re-exports

pub use super::super::asset;

pub use super::super::compiletime;

pub use super::super::helper;

pub use super::super::smoke_test;

pub use super::super::version;

pub use super::super::process as process_tools;

pub use ::error_tools;

pub use ::collection_tools;

pub use ::impls_index;

pub use ::mem_tools;

pub use ::typing_tools;

pub use ::diagnostics_tools;

Modules

binary_heap

std::collections::BinaryHeap macros

btree_map

std::collections::BTreeMap macros

btree_set

std::collections::BTreeSet macros

collection

Module containing all collection macros

dependency

Namespace with dependencies.

error

Alias for std::error::BasicError.

exposed

Exposed namespace of the module.

hash_map

std::collections::HashMap macros

hash_set

std::collections::HashSet macros

implsindex

Collection of general purpose meta tools.

linked_list

std::collections::LinkedList macros

mem

Collection of general purpose meta tools.

orphan

Shared with parent namespace of the module

own

Own namespace of the module.

prelude

Prelude to use essentials: use my_module::prelude::*.

test

Tools for testing.

thiserror

github crates-io docs-rs

vec_deque

std::collections::VecDeque macros

vector

Vec macros

Macros

_impls_callback

Internal impls1 macro. Don’t use.

a_dbg_false

Asserts that a boolean expression is false at runtime.

a_dbg_id

Asserts that two expressions are identical.

a_dbg_not_id

Asserts that two expressions are not identical with each other.

a_dbg_true

Asserts that a boolean expression is true at runtime.

a_false

Asserts that a boolean expression is false at runtime.

a_id

Asserts that two expressions are identical to each other (using PartialEq). Prints nice diff.

a_not_id

Asserts that two expressions are not identical to each other (using PartialEq). Prints nice diff.

a_true

Asserts that a boolean expression is true at runtime.

bmap

Creates a BTreeMap from a list of key-value pairs.

bset

Creates a BTreeSet from a list of elements.

cta_mem_same_size

Compile-time assertion that two values have the same size.

cta_ptr_same_size

Compile-time assertion that memory behind two references have the same size.

cta_true

Macro to compare meta condition is true at compile-time.

cta_type_same_align

Compile-time assertion of having the same align.

cta_type_same_size

Compile-time assertion that two types have the same size.

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.

deque

Creates a VecDeque from a list of elements.

dlist

Creates a Vec from a list of elements.

doc_file_test

Test a file with documentation.

fn_name

Get name of a function.

fn_rename

Macro to rename function.

fns

Split functions.

fns2

Split functions.

hmap

Creates a HashMap from a list of key-value pairs.

hset

Creates a HashSet from a list of elements.

implements

Macro implements to answer the question: does it implement a trait?

impls

Macros to put each function under a named macro to index every function in a class.

impls1

Define implementation putting each function under a macro.

impls2

Define implementation putting each function under a macro.

impls3

Macros to put each function under a named macro to index every function in a class.

impls_optional

Define implementation putting each function under a macro. Use index! to generate code for each element. Unlike elements of impls_optional!, elements of [impls] are mandatory to be used in index!.

index

Index of items.

inspect_to_str_type_of

Macro to inspect type of a variable and its size exporting it as a string.

inspect_type_of

Macro to inspect type of a variable and its size printing into stdout and exporting it as a string.

instance_of

Macro instance_of to answer the question: does it implement a trait? Alias of the macro implements.

into_bmap

Creates a BTreeMap from a list of key-value pairs.

into_bset

Creates a BTreeSet from a list of elements.

into_dlist

Creates a Vec from a list of elements.

into_hmap

Creates a HashMap from a list of key-value pairs.

into_hset

Creates a HashSet from a list of elements.

into_llist

Creates a LinkedList from a llist of elements.

into_vec

Creates a Vec from a list of elements.

into_vecd

Creates a VecDeque from a list of elements.

is_slice

Macro to answer the question: is it a slice?

llist

Creates a LinkedList from a llist of elements.

num

Required to convert integets to floats.

tests_impls

Define implementation putting each function under a macro and adding attribute #[ test ]. Use index! to generate code for each element. Unlike elements of [test_impls_optional!], elements of [test_impls] are mandatory to be used in index!.

tests_impls_optional

Define implementation putting each function under a macro and adding attribute #[ test ]. Use index! to generate code for each element. Unlike elements of [test_impls!], elements of [test_impls_optional] are optional to be used in index!.

tests_index

Index of items.

Structs

BTreeMap

An ordered map based on a B-Tree.

BTreeSet

An ordered set based on a B-Tree.

BinaryHeap

A priority queue implemented with a binary heap.

Bmap

An ordered map based on a B-Tree.

Bset

An ordered set based on a B-Tree.

Deque

A double-ended queue implemented with a growable ring buffer.

Dlist

A contiguous growable array type, written as Vec<T>, short for ‘vector’.

HashMap

A hash map implemented with quadratic probing and SIMD lookup.

HashSet

A hash set implemented as a HashMap where the value is ().

Hmap

A hash map implemented with quadratic probing and SIMD lookup.

Hset

A hash set implemented as a HashMap where the value is ().

LinkedList

A doubly-linked list with owned nodes.

Llist

A doubly-linked list with owned nodes.

Map

A hash map implemented with quadratic probing and SIMD lookup.

Set

A hash set implemented as a HashMap where the value is ().

SmokeModuleTest

Context for smoke testing of a module.

Vec

A contiguous growable array type, written as Vec<T>, short for ‘vector’.

VecDeque

A double-ended queue implemented with a growable ring buffer.

Traits

ErrWith

This trait allows adding extra context or information to an error, creating a tuple of the additional context and the original error. This is particularly useful for error handling when you want to include more details in the error without losing the original error value.

Functions

smoke_test_for_local_run

Run smoke test for local version of the module.

smoke_test_for_published_run

Run smoke test for published version of the module.

smoke_test_run

Run smoke test for the module. Run smoke test for the module.

smoke_tests_run

Run smoke test for both published and local version of the module.

Type Aliases

ResultWithReport

A type alias for a Result that contains an error which is a tuple of a report and an original error.

Attribute Macros

nightly

stable