Module prelude

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

Macros

_if_make

Generate code only if feature::make is enabled.

_impls_callback

Internal impls1 macro. Don’t use.

a_dbg_id

Asserts that two expressions are identical to each other.

a_dbg_not_id

Asserts that two expressions are not identical to each other.

a_dbg_true

Asserts that a boolean expression is true at runtime.

a_id

Asserts that two expressions are equal to each other (using PartialEq).

a_not_id

Asserts that two expressions are not equal to each other (using PartialEq).

a_true

Asserts that a boolean expression is true at runtime.

bmap

Literally just a BTreeMap literal with keys and values into’d.

braces_unwrap

Unwrap braces of token tree and pass its content to the passed callback. If token tree in not braced then it passed to callback as is.

bset

Literally just a BTreeSet literal with values into’d.

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.

fn_name

Get name of a function.

fn_rename

Macro to rename function.

fns

Split functions.

fns2

Split functions.

for_each

Module :: for_each

heap

Literally just a BinaryHeap literal with values into’d.

hmap

Literally just a HashMap literal with keys and values into’d.

hset

Literally just a HashSet literal with values into’d.

identity

Macro which returns its input as is.

idents_concat

implements

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

impls

Define implementation putting each function under a macro.

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.

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.

is_slice

Macro to answer the question: is it a slice?

list

Literally just a LinkedList literal with values into’d.

make

Variadic constructor.

mod_interface

Protocol of modularity unifying interface of a module and introducing layers.

tests_impls

Define implementation putting each function under a macro and adding attribute #[ test ].

tests_impls_optional

Define implementation putting each function under a macro and adding attribute #[ test ].

tests_index

Index of items.

types

Type constructor to define tuple wrapping a given type.

vecd

Literally just a VecDeque literal with values into’d.

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.

DynArray

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

EnumerableIteratorConsumable

Iterator for enumerable.

EnumerableIteratorNonConsumable

Iterator for enumerable.

HashMap

A hash map implemented with quadratic probing and SIMD lookup.

HashSet

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

HomoPair

Type constructor to wrap pair of the same type.

LinkedList

A doubly-linked list with owned nodes.

Many

Type constructor to wrap a vector.

Map

A hash map implemented with quadratic probing and SIMD lookup.

Pair

Type constructor to wrap two types into a tuple.

Set

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

Single

Type constructor to wrap a another type into a tuple.

Vec

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

VecDeque

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

Enums

Diff

A type returned by the diff_with function.

Either

The enum Either with variants Left and Right is a general purpose sum type with two cases.

EitherOrBoth

Value that either holds a single A or B, or both.

FoldWhile

An enum used for controlling the execution of fold_while.

MinMaxResult

MinMaxResult is an enum returned by minmax.

Position

A value yielded by WithPosition. Indicates the position of this element in the iterator results.

Traits

AsArray

Reinterpret as array.

AsSlice

Reinterpret as slice.

AsTuple

Reinterpret as tuple.

CloneAsArray

Clone as array.

CloneAsTuple

Clone as tuple.

Enumerable

Has length and indexed access.

IsolateOptionsAdapter

Adapter for IsolateOptions.

Itertools

An Iterator blanket implementation that provides extra adaptors and methods.

Make0

Constructor without arguments.

Make1

Constructor with single argument.

Make2

Constructor with two arguments.

Make3

Constructor with three arguments.

ParseOptionsAdapter

Adapter for ParseOptions.

PeekingNext

An iterator that allows peeking at an element before deciding to accept it.

SplitOptionsAdapter

Adapter for Split Options.

VectorizedFrom

Implementation of trait From to vectorize into/from.

VectorizedInto

Implementation of trait Into to vectorize into/from.

Functions

_clone_boxed

Clone boxed dyn.

Attribute Macros

clone_dyn

Derive macro to generate former for a structure. Former is variation of Builder Pattern.