Module gaunt::prelude

Use std or alloc prelude depending on selected cargo features

Macros

alloc_error_handlerExperimental

Attribute macro applied to a function to register it as a handler for allocation failure.

benchExperimental

Attribute macro applied to a function to turn it into a benchmark test.

cfg_accessibleExperimental

Keeps the item it’s applied to if the passed path is accessible, and removes it otherwise.

cfg_evalExperimental

Expands all #[cfg] and #[cfg_attr] attributes in the code fragment it’s applied to.

concat_bytesExperimental

Concatenates literals into a byte slice.

concat_identsExperimental

Concatenates identifiers into one identifier.

derive_constExperimental

Attribute macro used to apply derive macros for implementing traits in a const context.

format_args_nlExperimental

Same as format_args, but adds a newline in the end.

log_syntaxExperimental

Prints passed tokens into the standard output.

test_caseExperimental

An implementation detail of the #[test] and #[bench] macros.

trace_macrosExperimental

Enables or disables tracing functionality used for debugging other macros.

Clone

Derive macro generating an impl of the trait Clone.

Copy

Derive macro generating an impl of the trait Copy.

Debug

Derive macro generating an impl of the trait Debug.

Default

Derive macro generating an impl of the trait Default.

Eq

Derive macro generating an impl of the trait Eq.

Hash

Derive macro generating an impl of the trait Hash.

Ord

Derive macro generating an impl of the trait Ord.

PartialEq

Derive macro generating an impl of the trait PartialEq.

PartialOrd

Derive macro generating an impl of the trait PartialOrd.

assert

Asserts that a boolean expression is true at runtime.

cfg

Evaluates boolean combinations of configuration flags at compile-time.

column

Expands to the column number at which it was invoked.

compile_error

Causes compilation to fail with the given error message when encountered.

concat

Concatenates literals into a static string slice.

derive

Attribute macro used to apply derive macros.

env

Inspects an environment variable at compile time.

file

Expands to the file name in which it was invoked.

format_args

Constructs parameters for the other string-formatting macros.

global_allocator

Attribute macro applied to a static to register it as a global allocator.

include

Parses a file as an expression or an item according to the context.

include_bytes

Includes a file as a reference to a byte array.

include_str

Includes a UTF-8 encoded file as a string.

line

Expands to the line number on which it was invoked.

module_path

Expands to a string that represents the current module path.

option_env

Optionally inspects an environment variable at compile time.

stringify

Stringifies its arguments.

test

Attribute macro applied to a function to turn it into a unit test.

Structs

Box

A pointer type for heap allocation.

String

A UTF-8–encoded, growable string.

Vec

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

Enums

Option

The Option type. See the module level documentation for more.

Result

Result is a type that represents either success (Ok) or failure (Err).

Traits

AsMut

Used to do a cheap mutable-to-mutable reference conversion.

AsRef

Used to do a cheap reference-to-reference conversion.

Clone

A common trait for the ability to explicitly duplicate an object.

Copy

Types whose values can be duplicated simply by copying bits.

Default

A trait for giving a type a useful default value.

DoubleEndedIterator

An iterator able to yield elements from both ends.

Drop

Custom code within the destructor.

Eq

Trait for equality comparisons which are equivalence relations.

ExactSizeIterator

An iterator that knows its exact length.

Extend

Extend a collection with the contents of an iterator.

Fn

The version of the call operator that takes an immutable receiver.

FnMut

The version of the call operator that takes a mutable receiver.

FnOnce

The version of the call operator that takes a by-value receiver.

From

Used to do value-to-value conversions while consuming the input value. It is the reciprocal of Into.

Into

A value-to-value conversion that consumes the input value. The opposite of From.

IntoIterator

Conversion into an Iterator.

Iterator

A trait for dealing with iterators.

Ord

Trait for types that form a total order.

PartialEq

Trait for equality comparisons which are partial equivalence relations.

PartialOrd

Trait for types that form a partial order.

Send

Types that can be transferred across thread boundaries.

Sized

Types with a constant size known at compile time.

Sync

Types for which it is safe to share references between threads.

ToOwned

A generalization of Clone to borrowed data.

ToString

A trait for converting a value to a String.

Unpin

Types that can be safely moved after being pinned.

Functions

drop

Disposes of a value.