Expand description
All the crate’s items re-exported flat.
Note that these items are already re-exported (hidden) from the root, as is every other public module’s contents from their parent.
Macros§
- A helper for constructing macro constants.
core
Create aconst
raw pointer to a place, without creating an intermediate reference.core
Create amut
raw pointer to a place, without creating an intermediate reference.- Initializes a
[$T; $LEN]
array in multiple ways. core
Inline assembly.core
Asserts that a boolean expression is true at runtime.- Asserts the approximate equality of a series of expressions within
tolerance
. core
Asserts that two expressions are equal to each other.- Asserts the equality of a series of expressions.
core
Asserts that two expressions are not equal to each other.- bitfield
_bit··
Creates a custom bit field struct. - Captures the first token from a list of inputs.
- Captures the last token from a list of inputs.
- Captures all the tokens except the first one, as a tuple.
- cdbg
std
c
ustomizabledbg!
macro. core
Evaluates boolean combinations of configuration flags at compile-time.- A macro for defining
#[cfg]
if-else statements. - A for loop that is usable in compile-time contexts.
devela_macros
Returns the first non-empty argument.core
Expands to the column number at which it was invoked.core
Expands to the file name at which it was invoked.core
Expands to the line number at which it was invoked.core
Expands to a string representing the current module path.core
Causes compilation to fail with the given error message when encountered.core
Concatenates literals into a static string slice.- Asserts various comparisons on constants.
- Converts a const
bool
expression to a type-level boolean. - Swaps two mutable variables in a compile-time friendly manner.
core
Asserts that a boolean expression is true at runtime.core
Asserts that two expressions are equal to each other.core
Asserts that two expressions are not equal to each other.- Configures a feature as deprecated, warning if it is enabled.
- detect_
aarch64 std
and (AArch64 ortarget_arch="arm64ec"
)std
Tests at runtime whether anaarch64
feature is enabled. - detect_
x86 std
and (x86 or x86-64)std
Tests at runtime whether anx86/x86-64
feature is enabled. devela_macros
Generates a unit-only enum with variants associated to a specified range.- enumset
_bit_·
Defines an enum and an associated type set of its variants. core
Inspects an environment variable at compile time.devela_macros
Generates an expression for accessing a field of a tuple or struct.- format
alloc
alloc
Creates a String using interpolation of runtime expressions. core
Constructs parameters for the other string-formatting macros.- Returns a formatted
str
slice backed by a buffer, non-allocating. core
Module-level inline assembly.- A macro for constructing a unique sequential identifier generator.
- Defines a constant for every given identifier with a value of its index in the list.
devela_macros
Returns the total number of identifiers in its input.devela_macros
Returns the numbers of both total and unique identifiers in its input.devela_macros
Returns the number of unique identifiers in its input.i
nlineif
macro.- Implements a
NonValue[I|U]B<V>
. - A helper macro to concisely implement a few common utility traits.
core
Parses a file as an expression or an item according to the context.core
Includes a file as a reference to a byte array.- Includes a Rust source file relative to the project’s directory.
core
Includes a UTF-8 encoded file as a string.- Groups items together and expands them as if they were written directly.
- Declares a module by including a Rust source file relative to the project’s directory.
core
Expands to the offset in bytes of a field from the beginning of the given type.core
Optionally inspects an environment variable at compile time.core
Panics the current thread.paste
Allows to paste identifiers together.s
kipf
ormatting wrapper macro.- Returns the size of an expression in bytes.
- sleep4
std
A more compactThread::sleep
. - str
dep_const_str
core
Stringifies its arguments.core
Extracts the successful type of aTaskPoll<T>
.- thread_
local std
std
Declare a new thread local storage key of typeThreadLocalKey
. core
Indicates unfinished code.- Defines zero-cost, zero-sized, generic marker IDs.
- Defines zero-cost, zero-sized, type-safe resource IDs.
core
Indicates unimplemented code.core
Indicates unreachable code.- An unwrapper macro that works in compile-time.
- vec_
alloc
alloc
Creates aVec
containing the arguments. core
Writes formatted data into a buffer.core
Writes formatted data into a buffer, with a newline appended.
Structs§
- Memory-allocation-related operations.
- Angle
geom
A generic angle. - Arc
alloc
alloc
A thread-safe reference-counting pointer. - ArcWeak
alloc
alloc
A version ofArc
that holds a non-owning reference to the managed allocation. - Arch-related functionality.
- An archived
Array
- An archived
Array2d
- An archived
BareBox
- Archived
Boxed alloc
An archivedBoxed
- An archived
Destaque
- An archived
Stack
- A static 1-dimensional array backed by the core array primitive.
- A static 2-dimensional
Array
. - The resolver for an archived
Array2d
- The resolver for an archived
Array
- Array
Uninit unsafe_array
A static array allowing uninitialized elements. - Provides ASCII operations on
T
, most of them const. - Atomic
dep_atomic
⚛️atomic
A generic atomic wrapper type. - ⚛️
?core
A boolean type which can be safely shared between threads. - Atomic
F32 dep_portable_atomic
⚛️portable-atomic
A floating point type which can be safely shared between threads. - Atomic
F64 dep_portable_atomic
⚛️portable-atomic
A floating point type which can be safely shared between threads. - ⚛️
?core
A signed integer type which can be safely shared between threads. - ⚛️
?core
A signed integer type which can be safely shared between threads. - ⚛️
?core
A signed integer type which can be safely shared between threads. - ⚛️
?core
A signed integer type which can be safely shared between threads. - Atomic
I128 dep_portable_atomic
⚛️portable-atomic
A signed integer type which can be safely shared between threads. - ⚛️
?core
A signed integer type which can be safely shared between threads. - ⚛️
?core
A raw pointer type which can be safely shared between threads. - ⚛️
?core
An unsigned integer type which can be safely shared between threads. - ⚛️
?core
An unsigned integer type which can be safely shared between threads. - ⚛️
?core
An unsigned integer type which can be safely shared between threads. - ⚛️
?core
An unsigned integer type which can be safely shared between threads. - Atomic
U128 dep_portable_atomic
⚛️portable-atomic
An unsigned integer type which can be safely shared between threads. - ⚛️
?core
An unsigned integer type which can be safely shared between threads. - BTree
Map alloc
alloc
An ordered map based on a B-Tree. - BTree
Set alloc
alloc
An ordered set based on a B-Tree. - Backtrace
std
std
A captured OS thread stack backtrace. - A no-op pointer type, like a
Box
but without affecting howT
is stored. - The resolver for an archived
BareBox
- Barrier
std
std
Enables multiple threads to synchronize the beginning of some computation. std
Returned byBarrier::wait()
when all threads in the Barrier have rendezvoused.- Binary
Heap alloc
alloc
A priority queue implemented with a binary heap. - Bitwise
_bit··
Provides constant bitwise operations onT
. - Box
alloc
alloc
A pointer type that uniquely owns a heap allocation of typeT
. - Boxed
alloc
- Boxed
Resolver alloc
The resolver for an archivedBoxed
- A utility struct for searching bytes in slices.
core
Representation of a borrowed C string (SeeCString
).alloc
An owned, C-compatible, nul-terminated string with no nul bytes in the middle.- Aligns and pads a value to the length of a cache line.
- Cast
prim···
Provides const casting, joining and splitting operations between primitives. core
A mutable memory location.- Unicode scalars-related operations.
- Color
color
Color namespace for constants and methods - Provides comparing methods for
T
. - Condvar
std
std
A Condition Variable - An immutable, append-only, linear, functional, non-contiguous, list.
- 🔄 Iterates over the contents of a
ConstList
. - Coro
unsafe_async
Represents a single thread stackless coroutine. - CoroRun
unsafe_async
andalloc
A managed dynamic collection of single-threadCoro
utines. - Coro
Yield unsafe_async
- 🚩 The value has surpassed the bounds of the representable data space.
core
A struct to help withDebug
implementations.core
A struct to help withDebug
implementations.core
A struct to help withDebug
implementations.core
A struct to help withDebug
implementations.core
A struct to help withDebug
implementations.- A static double-ended queue and stack backed by an
Array
. - 🔄 An iterator over
Destaque
elements. - The resolver for an archived
Destaque
core
Opaque type representing the discriminant of an enum.- Faster divisor for division and modulo operations.
- DstArray
unsafe_layout
A static array for storing DSTs. - DstQueue
unsafe_layout
A statically allocated FIFO queue of DSTs. - DstQueue
Iter unsafe_layout
🔄 An iterator over the elements of aDstQueue
. - DstQueue
Iter Mut unsafe_layout
🔄 A mutable iterator over the elements of aDstQueue
. - DstQueue
PopHandle unsafe_layout
Handle returned byDstQueue::pop
(does the actual pop on drop). - DstStack
unsafe_layout
A statically allocated LIFO stack of DSTs. - DstStack
Iter unsafe_layout
🔄 An iterator over the elements of aDstStack
. - DstStack
Iter Mut unsafe_layout
🔄 A mutable iterator over the elements of aDstStack
. - DstValue
unsafe_layout
A statically allocated DST value. core
A span of time, withu64
seconds andu32
nanoseconds.- 🚩 The requested element has not been found.
- A namespaced wrapper for
std::env
functions and constants. - Extent
geom
An orthogonal extension inD
-space without a coordinate position. - 🚩 A failed conversion between two error types.
- A type-level logical false.
- Represents a fat pointer with separate data and metadata pointers.
- Provides comprehensive floating-point operations for
T
, most of them const. core
Represents a safely precompiled version of a format string and its arguments.- 🚩
core
The error type which is returned from formatting a message into a stream. core
Configuration for formatting.- Provides comprehensive fractional operations on
T
, most of them const. core
A future which never resolves, representing a computation that never finishes.core
A Future that wraps a function returningTaskPoll
.core
A future that is immediately ready with a value.- A return type for the calculated GCD and the Bézout coeficients.
- An EGC backed by a
StringNonul
. - Grapheme
String alloc
An EGC backed by aString
. - An EGC backed by an
StringU8
. - HashMap
dep_hashbrown
orstd
std?
An unordered hash map implemented with quadratic probing and SIMD lookup. - HashSet
dep_hashbrown
orstd
std?
An unordered hash set implemented as aHashMap
where the value is()
- Hasher
Fnv hash
andcast
A Fowler–Noll–Vo hasher. - Hasher
Fx hash
This hashing algorithm was extracted from the Rustc compiler. - Hasher
Pengy hash
A fast 64-bit non-cryptographic hash algorithm - A unique identifier based on a pinned stack-allocated reference.
- A unique identifier based on a pinned heap-allocated memory address.
- 🚩 The given index is out of bounds.
- Provides comprehensive integer operations on
T
, most of them const. - Represents an interval with a
lower
and anupper
bound. - 🚩 The given axis has an invalid length.
- 🚩 An invalid given character was found.
- 🚩 Invalid Utf-8 found while interpreting a byte sequence.
?std
Adds buffering to any reader.?std
Wraps a writer and buffers its output.?std
An iterator overu8
values of a reader.?std
Adapter to chain together two readers.?std
Wraps an in-memory buffer and provides it with aIoSeek
implementation.?std
LikeBufWriter
, but flushing whenever a newline (0x0a
,' '
) is detected.- IoLines
std
std
An iterator over the lines of an instance ofIoBufRead
. - IoSink
std
std
A writer which will move data into the void. - IoSlice
std
std
A buffer type used withIoWrite::write_vectored
. - IoSlice
Mut std
std
A buffer type used withIoRead::read_vectored
. - IoSplit
std
std
An iterator over the contents of an instance of BufRead split on a particular byte. ?std
Reader adapter which limits the bytes read from an underlying reader.- 🔄
core
An iterator that links two iterators together, in a chain. - 🔄
core
An iterator that clones the elements of an underlying iterator. - 🔄
core
An iterator that copies the elements of an underlying iterator. - 🔄
core
An iterator that repeats endlessly. - 🔄
core
An iterator that yields nothing. - 🔄
core
An iterator that yields the current count and the element during iteration. - 🔄
core
An iterator that filters the elements ofiter
withpredicate
. - 🔄
core
An iterator that usesf
to both filter and map elements fromiter
. - 🔄
core
An iterator that maps each element to an iterator, and yields their elements. - 🔄
core
An iterator that flattens one level of nesting in an iterator of iterables. - 🔄
core
An iterator where each iteration calls a closureF: FnMut() -> Option<T>
. - 🔄
core
An iterator that yieldsNone
forever after the underlying yieldsNone
once. - 🔄
core
An iterator that calls a fn with a reference to each element before yielding it. - 🔄
core
An iterator that maps the values of iter withf
. - 🔄
core
An iterator that only accepts elements whilepredicate
returnsSome(_)
. - 🔄
core
An iterator that yields an element exactly once. - 🔄
core
An iterator that yields a single elementA
by callingF: FnOnce() -> A
. - Iter
Path std
- 🔄
std
An iterator over the Components of a Path. - 🔄
core
An iterator with apeek()
that returns an optional ref to the next element. - 🔄
core
An iterator that repeats an element endlessly. - 🔄
core
An iterator that endlessly repeatsA
by callingF: FnMut() -> A
. - 🔄
core
A double-ended iterator with the direction inverted. - 🔄
core
An iterator to maintain state while iterating another iterator. - 🔄
core
An iterator that skips overn
elements ofiter
. - 🔄
core
An iterator that rejects elements whilepredicate
returnstrue
. - 🔄
core
An iterator for stepping iterators by a custom amount. - 🔄
core
An iterator where each successive item is computed based on the preceding one. - 🔄
core
An iterator that only iterates over the firstn
iterations ofiter
. - 🔄
core
An iterator that only accepts elements whilepredicate
returnstrue
. - 🔄
core
An iterator that iterates two other iterators simultaneously. - 🚩 The key already exists.
- LINUX_
ERRNO linux
Linuxsys/errno.h
constants. - LINUX_
FILENO linux
Linux file descriptor constants. - LINUX_
IOCTL linux
Linuxioctl
constants. - LINUX_
SIGACTION linux
Linux flag constants forLinuxSigaction
. - LINUX_
SIGNAL linux
Linux standard signals constants. - LINUX_
SYS_ AARC H64 linux
Linuxsys/syscall.h
constants foraarch64
. - LINUX_
SYS_ ARM linux
Linuxsys/syscall.h
constants forarmv7
. - LINUX_
SYS_ RISCV linux
Linuxsys/syscall.h
constants forriscv
. - LINUX_
SYS_ X86 linux
Linuxsys/syscall.h
constants forx86
. - LINUX_
SYS_ X86_ 64 linux
Linuxsys/syscall.h
constants forx86_64
. - LINUX_
TERMIOS_ CFLAG linux
LinuxTermios
control flags. - LINUX_
TERMIOS_ IFLAG linux
LinuxTermios
input flags. - LINUX_
TERMIOS_ LFLAG linux
LinuxTermios
local flags. - LINUX_
TERMIOS_ OFLAG linux
LinuxTermios
output flags. - Layout
alloc
alloc
Layout of a block of memory. - Layout
Error alloc
alloc
The parameters given to aLayout
constructor did not satisfy the constraints. core
A value which is initialized on the first access.- Lgc16
rand
A 16-bit LCG pseudo-random number generator. - Linked
List alloc
alloc
A doubly-linked list with owned nodes. - Linux
Sigaction linux
Represents thesigaction
structure from libc. Examine and change a signal action. - Linux
Sigset linux
A set of signals. - Linux
Terminal unsafe_syscall
andlinux
Linux terminal manager. - Linux
Terminal Size linux
The size of the terminal. - Linux
Termios linux
Represents thetermios
structure from libc, used to control terminal I/O. - Linux
Timespec linux
Represents thetimespec
structure from libc. Time in seconds and nanoseconds. core
A wrapper to inhibit compiler from automatically callingT
’s destructor.- Memory-related operations.
- Represents a mismatch between an expected
need
and an encounteredhave
. - 🚩 The given capacity did not match the required constraints.
- 🚩 The dimensions given did not match the elements provided.
- 🚩 The given indices does not match the expected order.
- Mutex
std
std
A mutual exclusion primitive useful for protecting shared data - Mutex
Guard std
std
An RAII implementation of a “scoped lock” of a mutex. - 🚩 The node is empty.
- 🚩 The link is not set.
- 🚩 The link is not unique.
- A signed integer that is known not to equal some specific value.
- An unsigned integer that is known not to equal some specific value.
- An unsigned integer that is known not to equal some specific value.
core
A value that is known not to equal zero.- 🚩 There are not enough elements for the operation.
- 🚩 There is not enough free space for the operation.
- 🚩 The requested functionality is not implemented.
- 🚩 The requested functionality is not supported by this type.
- Once
std
std
A synchronization primitive which can be used to run a one-time global initialization. core
A cell which can nominally be written to only once.- Once
Lock std
std
A synchronization primitive which can be written to only once. - Once
State std
std
State yielded toOnce::call_once_force()
’s closure parameter. - The type returned from
ExtOption::fmt_or_empty
. - The type returned from
ExtOption::fmt_or
. - The type returned from
ExtOption::fmt_or_else
. std
Borrowed reference to an OS string (SeeOsString
).std
A type that can represent owned, mutable platform-native strings, but is cheaply inter-convertible with Rust strings.- A return type encapsulating an owned state
S
and a valueV
. core
A simple wrapper around a type to assert that it is unwind safe.core
A struct providing information about a panic.core
A struct containing information about the location of a panic.- 🚩
core
An error which can be returned when parsing an float. - 🚩
core
An error which can be returned when parsing an integer. - 🚩 The operation could only add a subset of the elements.
- Path
std
std
A slice of a path (akin tostr
). - PathBuf
std
std
An owned, mutable path (akin toString
). - Path
Display std
std
Wraps a Windows path prefix as well as its unparsed string representation.core
Zero-sized type used to mark things that “act like” they own aT
.core
A marker type which does not implementUnpin
.core
A pointer which pins its pointee in place.- Pinned
unsafe_ptr
A wrapper for structurally pinned data. - Pnm
image
A collection of methods for encoding and decoding PNM bitmap formats. - Point
geom
A coordinate position inD
-space without extent. - Points
geom
- Poison
Error std
🚩std
A type of error which can be returned whenever a lock is acquired. - Pointer-related operations.
core
*mut T
but non-zero and covariant.- Random
State std
std
The default state forHashMapStd
. core
A range bounded inclusively below and exclusively above (start..end
).core
A range only bounded inclusively below (start..
).core
An unbounded range (..
).core
A range bounded inclusively below and above (start..=end
).core
A range only bounded exclusively above (..end
).core
A range only bounded inclusively above (..=end
).- Rc
alloc
alloc
A single-threaded reference-counting pointer. - RcWeak
alloc
alloc
A version ofRc
that holds a non-owning reference to the managed allocation. core
A wrapper type for an inmutably borrowed value from aRefCell<T>
core
A mutable memory location with dynamically checked borrow rules.core
A wrapper type for a mutably borrowed value from aRefCell<T>
core
A helper struct for reverse ordering.- RwLock
std
std
A reader-writer lock std
RAII structure used to release the shared read access of a lock when dropped.std
RAII structure used to release the exclusive write access of a lock when dropped.core
Provides intentionally-saturating arithmetic onT
.- Slice-related operations, most of them const.
- Provides sorting methods for arrays and slices of
T
, some of them const. - A static stack backed by an
Array
. - 🔄 An iterator over
Stack
elements. - The resolver for an archived
Stack
- Str
str
A string slice namespace. - String
alloc
alloc
A UTF-8–encoded, growable string. - String
Nonul _string_nonul
A UTF-8-encoded string, backed by an array withu8::MAX
bytes of capacity. Can’t contain nul chars. - String
U8 _string_u8
A UTF-8–encoded string, backed by an array withu8::MAX
bytes of capacity. - String
U16 _string_u16
A UTF-8–encoded string, backed by an array withu16::MAX
bytes of capacity. - String
U32 _string_u32
A UTF-8–encoded string, backed by an array withu32::MAX
bytes of capacity. - String
Usize _string_usize
A UTF-8–encoded string, backed by an array withusize::MAX
bytes of capacity. std
A measurement of a monotonically nondecreasing clock.- System
Time std
std
A measurement of the system clock. - 🚩 An error returned from the
duration_since
andelapsed
methods onSystemTime
. core
The context of an asynchronous task.core
Allows the implementor of a task executor to create aTaskWaker
.core
A virtual function pointer table that specifies the behavior of aTaskRawWaker
.core
A handle for waking up a task by notifying its executor that it is ready to be run.- Thread
std
std
A handle to a thread. std
An error returned byThreadLocalKey::try_with
.std
Thread factory, which can be used in order to configure the properties of a new thread.- Thread
Id std
std
A unique identifier for a running thread. std
An owned permission to join on a thread (block on its termination).std
A thread local storage key which owns its contents.- Thread
Scope std
std
A scope to spawn scoped threads in. std
An owned permission to join on a scoped thread (block on its termination).- Time
Split time
A full time split from years to nanoseconds. - Timecode
time
Timecode splitting and formatting. - A type-level logical true.
- 🚩
core
The error type returned when a checked integral type conversion fails. - Tuple
Fmt _tuple
- Tuple
Iter _tuple
🔄 An iterator over elements of aTuple
. - Tuple
Iter Mut _tuple
🔄 An iterator over exclusive references to elements of aTuple
. - Tuple
Iter Ref _tuple
🔄 An iterator over shared references to elements of aTuple
. core
Represents a globally unique identifier for a type.- A newtype-based ID that associates a resource with its inner ID.
- Unix
Time I64 time
64-bit Unix time, supporting negative values. - Unix
Time U32 time
32-bit Unix time, supporting only non-negative values. core
The core primitive for interior mutability in Rust.- A value with associated quantification.
- Vec
alloc
alloc
A contiguous growable array. - VecDeque
alloc
alloc
A double-ended growable queue. - VecPoints
geom
andalloc
A dynamic sequence ofD
-dimensionalPoint
s. - VecVector
alg
andalloc
A dynamic vector, backed by a primitiveVec
. - Vector
alg
A staticD
-dimensional vector, backed by a primitivearray
. std
A type indicating whether a timed wait on a condition variable returned due to a time out or not.- Wavelet
Haar wave
A Haar wavelet is a simple, piecewise-constant wavelet. - Wavelet
Unit Vec alloc
andwave
A single unit of the wavelet decomposition at a specific level and position. core
Provides intentionally-wrapped arithmetic onT
.- Xabc
rand
X ABC Algorithm Random Number Generator for 8-bit Devices. - XorShift8
rand
TheXorShift8
pseudo-random number generator. - XorShift8
Custom rand
A version ofXorShift8
that allows customizing the shift values. - XorShift16
rand
TheXorShift16
pseudo-random number generator. - XorShift32
rand
TheXorShift32
pseudo-random number generator. - XorShift64
rand
TheXorShift64
pseudo-random number generator. - XorShift128
rand
TheXorShift128
pseudo-random number generator. - XorShift128p
rand
TheXorShift128+
pseudo-random number generator. - Xoroshiro128pp
rand
TheXoroshiro128++
pseudo-random number generator. - Xyza8a
rand
A simple 8-bit pseudo-random number generator with 32-bit of state, based on the XorShift algorithm. - Xyza8b
rand
A simple 8-bit pseudo-random number generator with 32-bit of state, based on the XorShift algorithm. - char7
_char7
A 7-bit unicode scalar, limited to basic latin subset (ASCII). - char8
_char8
- char16
_char16
A 16-bit unicode scalar, limited to the Basic Multilingual Plane subset. - m128
dep_safe_arch
safe_arch
The data for a 128-bit SSE register of fourf32
lanes. - m256
dep_safe_arch
safe_arch
The data for a 256-bit AVX register of eightf32
lanes. - m128d
dep_safe_arch
safe_arch
The data for a 128-bit SSE register of twof64
values. - m128i
dep_safe_arch
safe_arch
The data for a 128-bit SSE register of integer data. - m256d
dep_safe_arch
safe_arch
The data for a 256-bit AVX register of fourf64
values. - m256i
dep_safe_arch
safe_arch
The data for a 256-bit AVX register of integer data.
Enums§
- Angle
Direction geom
The angle direction. - Angle
Kind geom
The angle kind, based on its normalized magnitude. - Ascii
Char ascii
One of the 128 Unicode characters from U+0000 through U+007F, often known as the ASCII subset. core
Atomic memory ordering.- Audio
Error audio
🚩+ An audio-related error. - BTree
MapEntry alloc
alloc
An ordered map based on a B-Tree. std
The current status of a backtrace.core
An endpoint of a range of keys.- Color
Error color
🚩+ A color-related error. - The type of compression applied to data.
core
Used to tell an operation whether it should exit early or go on as usual.- Cow
alloc
alloc
A clone-on-write smart pointer. - Draw
Error draw
🚩+ A drawing-related error. - The primary mode for data encoding.
core
A classification of floating point numbers.core
Possible alignments returned byFormatter::align
.- Font
Error font
🚩+ A font-related error. - Hash
MapEntry dep_hashbrown
orstd
std?
A view into a single entry in a map, which may either be vacant or occupied. - Image
Error image
🚩+ An image-related error. - 🚩
core
The error type for errors that can never happen. - 🚩+
?std
A list specifying general categories of I/O error. - Layout
Error layout
🚩+ A layout-related error. - Media
Error media··
🚩+ A media-related error. - Midi
Error midi
🚩+ A midi-related error. - The months of the year.
- 🚩+ A numeric-related error.
core
The result of a comparison between two values.- 🚩+
core
Kinds of errors that can cause parsing an integer to fail. std
A single component of a path.- Path
Prefix std
std
Windows path prefixes, e.g.,C:
or\\server\share.
- Represents the sign of a number.
core
Indicates whether a value is ready or if the current task is still pending.- TryLock
Error std
- Tuple
Element _tuple
An element of aTuple
. - Tuple
Element Mut _tuple
An exclusive reference to an element of aTuple
. - Tuple
Element Ref _tuple
A shared reference to an element of aTuple
. - UiError
ui··
A user-interface error. - UnitBi
unit
Binary unit prefixes. - UnitSi
unit
SI (metric) unit prefixes. - VecChunk
alloc
A persistent data structure that provides efficient append and concatenation operations. - Wavelet
Unit Role wave
Distinguishes the role of a component in wavelet analysis. - The days of the week.
- ⚙️
core
Equivalent to the corresponding C type. - Coroutine
State Experimental nightly_coro
core
The result of a coroutine resumption.
Constants§
- UNIX_
EPOCH std
std
ASystemTime
anchored to “1970-01-01 00:00:00 UTC”.
Statics§
- LINUX_
TERMINAL_ STATE unsafe_syscall
andlinux
anddep_atomic
anddep_bytemuck
State of the terminal saved globally, that can be restored from anywhere.
Traits§
core
The addition operator+
.core
The addition assignment operator+=
.core
A trait to emulate dynamic typing.core
Used to do a cheap mutable-to-mutable reference conversion.core
Used to do a cheap reference-to-reference conversion.core
b
formatting.core
The bitwise AND operator&
.core
The bitwise AND assignment operator&=
.- Provides bitwise operations on
T
. core
The bitwise OR operator|
.core
The bitwise OR assignment operator|=
.- Type size information in bits.
core
The bitwise XOR operator^
.core
The bitwise XOR assignment operator^=
.core
A trait for borrowing data.core
A trait for mutably borrowing data.- Type size information in bytes.
- Allows chaining transformations by passing values through a sequence of functions.
core
A common trait for the ability to explicitly duplicate an object.- Color
Base color
Base trait for general color data representation. - Allows to convert compile-time constants into type-level booleans.
- A trait for giving a type a useful default value in compile-time.
core
Types whose values can be duplicated simply by copying bits.- An abstract array data type.
- An abstract collection data type.
- An abstract double-ended queue data type.
- An abstract double-ended stack data type.
- An abstract queue data type.
- An abstract stack data type.
core
?
formatting.core
A trait for giving a type a useful default value.core
Used for immutable dereferencing operations, like*v
.core
Used for mutable dereferencing operations, like in*v = 1;
.core
Format trait for an empty format,{}
.core
The division operator/
.core
The division assignment operator/=
.core
Custom code within the destructor.- DstBuf
unsafe_layout
Represents the backing buffer for storing dynamically sized types. core
Trait for comparisons corresponding to equivalence relations.core
A trait representing the basic expectations for error values.- Extension trait providing convenience methods for
T:
Any
. - Extension trait providing convenience methods for
[T; N]
arrays. - A trait that provides additional methods for
Cell<Option>
. - Extension trait providing additional methods for
T:
Error
. - Extension trait for floating-point types. Associated methods.
- Extension trait for floating-point types. Associated constants.
- Extension trait providing additional methods for
Future
s. - Extension trait for type memory information and manipulation.
- Extension trait providing additional methods for
OptRes
. - Extension trait providing additional methods for
Option
. - ExtPath
std
Extension trait providing additional methods for paths. - Extension trait providing additional methods for
Result
. - Extension trait providing additional methods for
&[T]
. - Extension trait providing additional methods for
&mut [T]
. - ExtStr
str
Extension trait providing additional methods for&str
. - ExtString
str
andalloc
Extension trait providing additional methods forString
. - Extension trait providing additional methods for
Thread
s. - ExtVec
alloc
Extension trait providing additional methods forVec
. core
The version of the call operator that takes an immutable receiver.core
The version of the call operator that takes a mutable receiver.core
The version of the call operator that takes a by-value receiver.core
Used to do value-to-value conversions while consuming the input value.core
Parse a value from a string.core
An asynchronous computation obtained by use ofasync
.- Global
Alloc alloc
alloc
- Common trait for EGC types.
core
A hashable type.core
A trait for hashing an arbitrary stream of bytes.core
A trait for creating instances ofHasher
.- Allows attaching operations or side effects to a value without breaking its flow.
core
Used for indexing operations (container[index]
) in immutable contexts.core
Used for indexing operations (container[index]
) in mutable contexts.core
A value-to-value conversion that consumes the input value.core
Conversion into aFuture
.?std
A type ofRead
er which has an internal buffer.?std
Allows for reading bytes from a source.?std
Provides a cursor which can be moved within a stream of bytes.?std
A trait for objects which are byte-oriented sinks.core
A trait for dealing with iterators.core
An iterator able to yield elements from both ends.core
An iterator that knows its exact length.core
Extend a collection with the contents of an iterator.core
Conversion from anIterator
.core
An iterator that always continues to yieldNone
when exhausted.core
Conversion into anIterator
.core
Represents types that can be created by multiplying elements of an iterator.core
Represents types that can be created by summing up an iterator.core
e
formatting.core
x
formatting.- Marker trait to verify memory alignment between two types.
- MemPod
unsafe_layout
Indicates a type is Plain Old Data, and meets specific memory layout guarantees. core
The multiplication operator*
.core
The multiplication assignment operator*=
.core
The unary negation operator-
.core
The unary logical negation operator!
.- Common trait for numeric types.
- Common trait for integer types.
- Common auto-trait for referenced numeric types.
- Common auto-trait for referenced integer types.
- NumTo
Str fmt
Converts a number into a string representation, storing it into a byte slice. - NumVector
alg
A common trait for all vectors. core
o
formatting.core
Trait for types that form a total order.core
A marker trait which represents a shared reference considered unwind safe.core
A marker trait which represents “panic safe” types in Rust.core
Trait for comparisons using the equality operator.core
Trait for types that form a partial order.core
p
formatting.- Primitive
Cast cast
Offers methods for casting between primitives. - Primitive
Join join
Offers methods to construct a primitive from an array or slice of smaller primitives. - Primitive
Split split
Offers methods to split a primitive into an array of smaller primitives. core
Implemented by Rust’s built-in range typescore
The remainder operator%
.core
The remainder assignment operator%=
.core
Types that can be transferred across thread boundaries.core
Types with a constant size known at compile time.- Allows to be generic in respect of the data storage.
core
The subtraction operator-
.core
The subtraction assignment operator-=
.core
Types for which it is safe to share references between threads.- Task
Wake alloc
alloc
The implementation of waking a task on an executor. core
Writing or formatting into Unicode-accepting buffers or streams.- ToOwned
alloc
alloc
A generalization of Clone to borrowed data. - ToString
alloc
alloc
A trait for converting a value to aString
. core
Simple and safe type conversions that may fail in a controlled way.core
An attempted conversion that consumes self, which may or may not be expensive.- Tuple
_tuple
Extension trait providing convenience methods for tuples. - Represents an association between a resource and its inner data type.
- Common trait for unicode scalar types.
- Unit
unit
Unit prefixes. core
Types that do not require any pinning guarantees.core
E
formatting.core
X
formatting.- Wavelet
Compression Vec alloc
andwave
Trait for lossy compression of wavelet coefficients. - Wavelet
Transform Vec alloc
andwave
Trait defining essential wavelet transform operations. - Coroutine
Experimental nightly_coro
core
The trait implemented by builtin coroutine types.
Functions§
core
Creates an array[T; N]
, where eachT
is returned fromcb
from its index.core
Converts a mutable reference toT
into&mut [T; 1]
(without copying).core
Converts a reference toT
into&[T; 1]
(without copying).core
Makes a soundness promise to the compiler that thecond
ition holds.core
A compiler memory fence.core
An atomic fence.core
Hints the compiler to be maximally pessimistic about what black_box could do.- Returns the rounded up size in bytes from a size in bits.
- crate_
root std
Returns an absolutePathBuf
, relative to thecrate
’s root. - Like
crate_root
but returns aString
. - fmt_
format alloc
alloc
Takes anFmtArguments
struct and returns the resulting formatted string. core
Takes an output stream, and anFmtArguments
struct.- Returns a formatted
str
slice backed by a buffer, non-allocating. - future_
block std
Blocks the thread until thefuture
is ready. core
Creates aFuturePending
future.core
Creates aFutureReady
.core
The identity function. Just returns back its input.?std
Copies the entire contents of a reader into a writer.- io_
empty std
std
Creates a value that is always at EOF for reads, and ignores all data written. std
Read all bytes from a reader into a new String- io_
repeat std
std
Creates an instance of a reader that infinitely repeats one byte. - io_sink
std
std
Creates an instance of a writer which will successfully consume all data. - io_
stderr std
std
Constructs a new handle to the standard error of the current process. - io_
stdin std
std
Constructs a new handle to the standard input of the current process. - io_
stdout std
std
Constructs a new handle to the standard output of the current process. - is_
leap_ year time
Returnstrue
if the providedyear
is a leap year. core
Creates an iterator that yields nothing.core
Creates an iterator that calls the given closureF: FnMut() -> Option<T>
.core
Creates an iterator that yields an element exactly once.core
Creates an iterator that lazily generates a value exactly once.core
Creates an iterator that endlessly repeats a single element.core
Creates an iterator that endlessly repeats callingF: FnMut() -> A
.core
Creates an iterator where each successive item is computed based on the previous.core
Converts the arguments to iterators and zips them.- linux_
eprint unsafe_syscall
andlinux
Prints a string slice to standard error. - linux_
eprintln unsafe_syscall
andlinux
Prints a string slice to standard error, with a newline. - linux_
get_ byte unsafe_syscall
andlinux
Gets a single byte from stdin. - linux_
get_ char unsafe_syscall
andlinux
Gets a singlechar
from stdin, orNone
if the bytes are not valid utf-8. - linux_
get_ dirty_ char unsafe_syscall
andlinux
Gets either a singlechar
from stdin, or the replacement character. - linux_
get_ line unsafe_syscall
andlinux
Gets a string from stdin backed by abuffer
, until a newline. - linux_
get_ str unsafe_syscall
andlinux
Gets a string from stdin backed by abuffer
, until thestop
char is received. - linux_
get_ utf8_ bytes unsafe_syscall
andlinux
Gets a utf-8 encoded byte sequence from stdin representing achar
. - linux_
getpid unsafe_syscall
andlinux
Returns the current process number. - linux_
pause_ until_ char unsafe_syscall
andlinux
Pauses execution until receiving from stdin anychar
in thelist
. - linux_
print unsafe_syscall
andlinux
Prints a string slice to standard output. - linux_
print_ bytes unsafe_syscall
andlinux
Prints a byte slice to stdout. - linux_
println unsafe_syscall
andlinux
Prints a string slice to standard output, with a newline. - linux_
prompt unsafe_syscall
andlinux
Prompts the user for a string from stdin, backed by abuffer
. - linux_
random_ bytes unsafe_syscall
andlinux
Fills the givenbuffer
with random bytes that may not be cryptographically secure. - linux_
random_ u8 unsafe_syscall
andlinux
Generates a randomu8
value that may not be criptographically secure. - linux_
random_ u16 unsafe_syscall
andlinux
Generates a randomu16
value that may not be criptographically secure. - linux_
random_ u32 unsafe_syscall
andlinux
Generates a randomu32
value that may not be criptographically secure. - linux_
random_ u64 unsafe_syscall
andlinux
Generates a randomu64
value that may not be criptographically secure. - linux_
random_ u128 unsafe_syscall
andlinux
Generates a randomu128
value that may not be criptographically secure. - linux_
sig_ handler_ no_ return unsafe_syscall
andlinux
Registers multiple signals using a handler function that never returns. - linux_
sleep unsafe_syscall
andlinux
Suspends execution of calling thread forduration
. - linux_
sys_ ⚠exit unsafe_syscall
andlinux
Performs anexit
syscall. - linux_
sys_ ⚠getpid unsafe_syscall
andlinux
Performs agetpid
syscall. - linux_
sys_ ⚠getrandom unsafe_syscall
andlinux
Performs agetrandom
syscall. - linux_
sys_ ⚠ioctl unsafe_syscall
andlinux
Performs anioctl
syscall. - linux_
sys_ ⚠nanosleep unsafe_syscall
andlinux
Performs ananosleep
syscall. - linux_
sys_ ⚠read unsafe_syscall
andlinux
Performs aread
syscall. - linux_
sys_ ⚠rt_ sigaction unsafe_syscall
andlinux
Performs anrt_sigaction
syscall. - linux_
sys_ ⚠write unsafe_syscall
andlinux
Performs awrite
syscall. - panic_
any std
std
Panic the current thread with the given message as the panic payload. - panic_
catch std
std
Invokes a closure, capturing the cause of an unwinding panic if one occurs. - panic_
resume std
std
Triggers a panic without invoking the panic hook. std
Registers a custom panic hook, replacing the previously registered hook.std
Unregisters the current panic hook, returns it and registers the default hook in its place.- prime_
number_ theorem std
or_float_f64
The prime number theorem formula. core
Signals the processor that it is running in a busy-wait spin-loop.- task_
waker_ noop unsafe_async
Creates a newWaker
that does nothing whenwake
is called. - transmute⚠
Deprecated core
Reinterprets the bits of a value of one type as another type. core
Informs the compiler that the current calling site is not reachable.- iter_
from_ coroutine Experimental nightly_coro
core
Creates an iterator where each iteration calls the provided coroutine.
Type Aliases§
- Audio
Result audio
⚖️ An audio-related result. - Color
Result color
⚖️ A color-related result. - Destaque
U8 _destaque_u8
ADestaque
with an 8-bit index size. - Destaque
U16 _destaque_u16
ADestaque
with a 16-bit index size. - Destaque
U32 _destaque_u32
ADestaque
with a 32-bit index size. - Destaque
Usize _destaque_usize
ADestaque
with a pointer-sized index size. - Draw
Result draw
⚖️ A drawing-related result. - DstArray
Usize unsafe_layout
A statically allocated buffer for storing DSTs with pointer alignment. - DstQueue
Usize unsafe_layout
A statically allocated FIFO queue of DSTs with pointer alignment. - DstStack
Usize unsafe_layout
A statically allocated LIFO stack of DSTs with pointer alignment. - DstValue
Usize unsafe_layout
A statically allocated DST value with pointer alignment. - DstVec
Usize unsafe_layout
andalloc
A dynamically allocated buffer for storing DSTs with pointer alignment. - Extent2d
geom
A 2-dimensionalExtent
. - Extent3d
geom
A 3-dimensionalExtent
. - ⚖️ The type returned by formatter methods.
- Font
Result font
⚖️ A font-related result. - Hash
MapFx hash
and (std
, ordep_hashbrown
andhash
)AHashMap
using a default Fx hasher. - Hash
MapStd std
TheHashMap
in the standard library. - Hash
SetFx hash
and (std
, ordep_hashbrown
andhash
)AHashSet
using a default Fx hasher. - Hash
SetStd std
TheHashSet
in the standard library. - Hasher
Build Fnv hash
andcast
A builder for default Fnv hashers. - Hasher
Build Fx hash
A builder for default Fx hashers. - Image
Result image
⚖️ An image-related result. - LINUX_
SYS linux
Linuxsys/syscall.h
constants for the current compilation target. - Layout
Result layout
⚖️ A layout-related result. - Lock
Result std
std
A type alias for the result of a lock method which can be poisoned. - Media
Result media··
⚖️ A media-related result. - Midi
Result midi
⚖️ A midi-related result. - Represents the absence of a number.
- NoTime
time
Represents the absence of time. - A signed integer that is known not to equal its most extreme value (
MIN
). - An unsigned integer that is known not to equal its most extreme value (
MAX
). - An unsigned integer that is known not to equal its most extreme value (
MAX
). core
A signed integer that is known not to equal zero.core
A signed integer that is known not to equal zero.core
A signed integer that is known not to equal zero.core
A signed integer that is known not to equal zero.core
A signed integer that is known not to equal zero.core
A signed integer that is known not to equal zero.core
An unsigned integer that is known not to equal zero.core
An unsigned integer that is known not to equal zero.core
An unsigned integer that is known not to equal zero.core
An unsigned integer that is known not to equal zero.core
An unsigned integer that is known not to equal zero.core
An unsigned integer that is known not to equal zero.- ⚖️ A numeric-related result.
- An optional result for simple ternary logic.
- Point2d
geom
A specific position in 2d-space without a size. - Point3d
geom
A specific position in 3d-space without a size. - StackU8
_stack_u8
AStack
with an 8-bit index size. - Stack
U16 _stack_u16
AStack
with a 16-bit index size. - Stack
U32 _stack_u32
AStack
with a 32-bit index size. - Stack
Usize _stack_usize
AStack
with a pointer-sized index size. - Thread
Result std
- A time split from hours to nanoseconds.
- A time split from hours to seconds, normalized (128b size & payload).
- Time
Split Hour Sec time
A time split from hours to seconds. - A time split from hours to seconds, normalized (128b size, 80b payload).
- A time split from milliseconds to nanoseconds.
- A time split from milliseconds to nanoseconds, normalized (48b size & payload).
- Time
Split Norm time
A time split from years to nanoseconds, normalized (192b size, 152b payload). - Time
Split Year Day time
A time split from years to days. - A time split from years to days, normalized (128b size, 80b payload).
- Time
Split Year Sec time
A time split from years to seconds. - A time split from years to seconds, normalized (128b size, 104b payload).
- ⚖️
std
A type alias for the result of a nonblocking locking method. - UiResult
ui··
⚖️ A user-interface result. - Vector2d
alg
A static 2-dimensional vector. - Vector3d
alg
A static 3-dimensional vector. - ⚙️
core
Equivalent to the corresponding C type. - ⚙️
core
Equivalent to the corresponding C type. - ⚙️
core
Equivalent to the corresponding C type. - ⚙️
core
Equivalent to the corresponding C type. - ⚙️
core
Equivalent to the corresponding C type. - ⚙️
core
Equivalent to the corresponding C type. - ⚙️
core
Equivalent to the corresponding C type. - ⚙️
core
Equivalent to the corresponding C type. - ⚙️
core
Equivalent to the corresponding C type. - ⚙️
core
Equivalent to the corresponding C type. - ⚙️
core
Equivalent to the corresponding C type. - ⚙️
core
Equivalent to the corresponding C type. - ⚙️
core
Equivalent to the corresponding C type. - ⚙️ A pointer-sized floating-point primitive.
- ⚙️ A downcasted pointer-sized signed integer primitive.
- ⚙️ An upcasted pointer-sized signed integer primitive.
- ⚙️ A downcasted pointer-sized unsigned integer primitive.
- ⚙️ An upcasted pointer-sized unsigned integer primitive.
Unions§
core
A wrapper type to construct uninitialized instances ofT
.
Attribute Macros§
devela_macros
Conditionally compiles the thing it is attached to based on the predicate.devela_macros
Conditionally compiles the given attributes based on the predicate.- autodiff
Experimental nightly_autodiff
core
Automatic Differentiation macro.
Derive Macros§
core
Derive macro generating an impl of the traitClone
.core
Derive macro generating an impl of the traitCopy
.core
?
formatting.core
Derive macro generating an impl of the traitDefault
.core
Derive macro generating an impl of the traitEq
.core
Derive macro generating an impl of the traitHash
.core
Derive macro generating an impl of the traitPartialOrd
. The behavior of this macro is described in detail here.