Expand description
The 2021 version of the core prelude.
See the module-level documentation for more.
Macros§
- Asserts that a boolean expression is
true
at runtime. - Evaluates boolean combinations of configuration flags at compile-time.
- Expands to the column number at which it was invoked.
- Causes compilation to fail with the given error message when encountered.
- Concatenates literals into a static string slice.
- Inspects an environment variable at compile time.
- Expands to the file name in which it was invoked.
- Constructs parameters for the other string-formatting macros.
- Parses a file as an expression or an item according to the context.
- Includes a file as a reference to a byte array.
- Includes a UTF-8 encoded file as a string.
- Expands to the line number on which it was invoked.
- Expands to a string that represents the current module path.
- Optionally inspects an environment variable at compile time.
- Stringifies its arguments.
- concat_
bytes Experimental Concatenates literals into a byte slice. - concat_
idents Experimental Concatenates identifiers into one identifier. - deref
Experimental Unstable placeholder for deref patterns. - format_
args_ nl Experimental Same asformat_args
, but adds a newline in the end. - log_
syntax Experimental Prints passed tokens into the standard output. - trace_
macros Experimental Enables or disables tracing functionality used for debugging other macros. - type_
ascribe Experimental Unstable placeholder for type ascription.
Enums§
- The
Option
type. See the module level documentation for more.
Traits§
- Used to do a cheap mutable-to-mutable reference conversion.
- Used to do a cheap reference-to-reference conversion.
- A common trait for the ability to explicitly duplicate an object.
- Types whose values can be duplicated simply by copying bits.
- A trait for giving a type a useful default value.
- An iterator able to yield elements from both ends.
- Custom code within the destructor.
- Trait for comparisons corresponding to equivalence relations.
- An iterator that knows its exact length.
- Extend a collection with the contents of an iterator.
- The version of the call operator that takes an immutable receiver.
- The version of the call operator that takes a mutable receiver.
- The version of the call operator that takes a by-value receiver.
- Used to do value-to-value conversions while consuming the input value. It is the reciprocal of
Into
. - Conversion from an
Iterator
. - A value-to-value conversion that consumes the input value. The opposite of
From
. - Conversion into an
Iterator
. - A trait for dealing with iterators.
- Trait for types that form a total order.
- Trait for comparisons using the equality operator.
- Trait for types that form a partial order.
- Types that can be transferred across thread boundaries.
- Types with a constant size known at compile time.
- Types for which it is safe to share references between threads.
- Simple and safe type conversions that may fail in a controlled way under some circumstances. It is the reciprocal of
TryInto
. - An attempted conversion that consumes
self
, which may or may not be expensive. - Types that do not require any pinning guarantees.
Functions§
- Returns the ABI-required minimum alignment of a type in bytes.
- Returns the ABI-required minimum alignment of the type of the value that
val
points to in bytes. - Disposes of a value.
- Returns the size of a type in bytes.
- Returns the size of the pointed-to value in bytes.
Attribute Macros§
- Attribute macro used to apply derive macros.
- Attribute macro applied to a static to register it as a global allocator.
- Attribute macro applied to a function to turn it into a unit test.
- alloc_
error_ handler Experimental Attribute macro applied to a function to register it as a handler for allocation failure. - bench
Experimental Attribute macro applied to a function to turn it into a benchmark test. - cfg_
accessible Experimental Keeps the item it’s applied to if the passed path is accessible, and removes it otherwise. - cfg_
eval Experimental Expands all#[cfg]
and#[cfg_attr]
attributes in the code fragment it’s applied to. - derive_
const Experimental Attribute macro used to apply derive macros for implementing traits in a const context. - test_
case Experimental An implementation detail of the#[test]
and#[bench]
macros.
Derive Macros§
- Derive macro generating an impl of the trait
Clone
. - Derive macro generating an impl of the trait
Copy
. - Derive macro generating an impl of the trait
Debug
. - Derive macro generating an impl of the trait
Default
. - Derive macro generating an impl of the trait
Eq
. - Derive macro generating an impl of the trait
Hash
. - Derive macro generating an impl of the trait
PartialOrd
. The behavior of this macro is described in detail here.