Expand description
All crate items re-exported in a single flat namespace.
This flat view appears here as zall, and it is also mirrored at the
crate root through a hidden all module. Every item in this namespace
is already forwarded upward, since public modules automatically
re-export their contents to their parent.
The name zall ensures rustdoc search shows each itemโs original
full path rather than the earlier-sorted all re-export.
Macrosยง
- CONST
- โ ๐๏ธ A helper for constructing macro constants.
- ansi
linuxorstd - ๐ฎ
Concatenates or prints
Ansiescape codes. - arch_
cmp avxanddep_safe_arch - ๐ฅ๏ธ
safe_archTurns a comparison operator token to the correct constant value. - arch_
round avxanddep_safe_arch - ๐ฅ๏ธ
safe_archTurns a round operator token to the correct constant value. - arena
- ๐๏ธ ๐งบ A custom memory arena generator.
- asm
- โ ๐ฅ๏ธ
coreInline assembly. - assert
- ๐ฏ
coreAsserts that a boolean expression is true at runtime. - assert_
approx_ eq_ all - ๐ฏ
Asserts the approximate equality of a series of expressions within
tolerance. - assert_
eq - ๐ฏ
coreAsserts that two expressions are equal to each other. - assert_
eq_ all - ๐ฏ Asserts the equality of a series of expressions.
- assert_
matches - ๐ฏ
coreAsserts that an expression matches the provided pattern. - assert_
ne - ๐ฏ
coreAsserts that two expressions are not equal to each other. - async_
ready - ๐งต โฌก
coreExtracts the successful type of aAsyncPoll<T>. - bitfield
- ๐๏ธ โซ๏ธ ๐ซ Defines a compact packed-field wrapper backed by an unsigned integer.
- buffer_
linear - ๐๏ธ ๐๏ธ Defines a linear buffer type over contiguous storage backends.
- buffer_
ring - ๐๏ธ ๐๏ธ Defines a ring buffer type over contiguous storage backends.
- capture_
first - โ Captures the first token from a list of inputs.
- capture_
last - โ Captures the last token from a list of inputs.
- capture_
tail_ tuple - โ Captures all the tokens except the first one, as a tuple.
- cast
- โ โ๏ธ Provides const primitive casting, joining and splitting operations.
- cdbg
std - โ ๐
customizabledbg!macro. - cfg
coreEvaluates boolean combinations of configuration flags at compile-time.- cfg_
select coreSelects code at compile-time based on cfg predicates.- ch
- ๐๏ธ ๐ Concisely creates any kind of Unicode scalar.
- cif
- โ proc
Evaluates to either a
trueoffalseliteral based on the predicate. - cmd
std - โ ๐ฅ๏ธ โฌก
Builds a
CommandFlowfrom one or more command invocations. - cmp
- โง โค Provides comparison operations using an operation-first syntax.
- coalesce
- โ proc Returns the first non-empty argument.
- code_
column - โ
coreExpands to the column number at which it was invoked. - code_
file - โ
coreExpands to the file name at which it was invoked. - code_
line - โ
coreExpands to the line number at which it was invoked. - code_
module - โ ๐งถ
coreExpands to a string representing the current module path. - compile_
error - โ ๐ฉ
coreCauses compilation to fail with the given message when encountered. - concat
- โ ๐
coreConcatenates literals into a static string slice. - const_
assert - ๐ฏ Asserts various comparisons on constants.
- const_
bool - โ โง
Converts a const
boolexpression to a type-level boolean. - const_
join - โ Joins multiple byte slices or string slices in compile-time.
- const_
warn - โ ๐ Emits a compile-time warning with a provided message.
- cswap
- โ Swaps two mutable variables in a compile-time friendly manner.
- debug_
assert - ๐ฏ
coreAsserts that a boolean expression is true at runtime. - debug_
assert_ eq - ๐ฏ
coreAsserts that two expressions are equal to each other. - debug_
assert_ matches - ๐ฏ
coreAsserts that an expression matches the provided pattern. - debug_
assert_ ne - ๐ฏ
coreAsserts that two expressions are not equal to each other. - define_
error - ๐๏ธ ๐ฉ Defines individual and composite error types.
- deprecate_
feature - โ Configures a feature as deprecated, warning if it is enabled.
- detect_
aarch64 stdand (AArch64 or ARM64EC) - ๐ฅ๏ธ
stdTests at runtime whether anaarch64feature is enabled. - detect_
x86 stdand (x86 or x86-64) - ๐ฅ๏ธ
stdTests at runtime whether anx86/x86-64feature is enabled. - digest
- ๐ ๐ ๐๏ธ Defines a selected cryptographic message-digest state type.
- dis
- ๐ ๐๏ธ
Constructs a
Distancewith inferred dimensionality. - divisor
- ๐๏ธ โ โ Defines a divisor struct for faster division and modulo operations.
- doclink
- โ Helps doc-linking items in downstream crates.
- enumint
- ๐๏ธ โ โ๏ธ proc Defines a compact enum over a contiguous integer interval.
- enumset
- โ ๐๏ธ โ โ โซ๏ธ Defines an enum and an associated type set of its variants.
- env_
- โ
coreInspects an environment variable at compile time. - ext
- ๐ ๐๏ธ
Constructs an
Extentwith inferred dimensionality. - field_
of - โ proc Generates an expression for accessing a field of a tuple or struct.
- fmtcat
- ๐น Writes concatenated formatted data into a byte buffer.
- fn_name
- โ ๐ Returns a best-effort name of the enclosing function.
- format
alloc - ๐น ๐๏ธ
allocCreates a String using interpolation of runtime expressions. - format_
args - ๐น
coreConstructs parameters for the other string-formatting macros. - format_
buf - ๐น
Returns a formatted
strslice backed by a buffer, non-allocating. - global_
asm - โ ๐ฅ๏ธ
coreModule-level inline assembly. - handle
- ๐๏ธ ๐ซ Defines a lightweight handle type.
- hook
- โ ๐ฑ Hooks one or more mutation steps into a value and returns it.
- id_seq
- ๐๏ธ ๐ซ A macro for constructing a unique sequential identifier generator.
- ident_
const_ index - โ Defines a constant for every given identifier with a value of its index in the list.
- ident_
total - โ proc Returns the total number of identifiers in its input.
- ident_
total_ unique - โ proc Returns the numbers of both total and unique identifiers in its input.
- ident_
unique - โ proc Returns the number of unique identifiers in its input.
- impl_
trait - โ ๐๏ธ A helper macro to concisely implement a few common utility traits.
- include
- โ
coreParses a file as an expression or an item according to the context. - include_
bytes - โ
coreIncludes a file as a reference to a byte array. - include_
from - โ Includes a Rust source file relative to the projectโs directory.
- include_
str - โ ๐งถ
coreIncludes a UTF-8 encoded file as a string. - init_
array - ๐ฑ ๐๏ธ
Initializes a
[$T; $LEN]array in multiple ways. - interval
- ๐
Creates an
Intervalusing extended range notation. - is
- โ Conditional evaluation.
- items
- โ ๐น
Groups
itemstogether and expands them as if they were written directly. - iter_
strided - ๐๏ธ ๐ Generates a strided iterator type over a slice.
- lane
- ๐๏ธ โ โ Defines a fixed-width lane type.
- lets
- โ A concise macro for declaring multiple variables at once.
- linux_
entry linux - ๐ง โ Defines the program entry point and main fn translation layer for Linux systems.
- macro_
apply_ alias - โ
Defines attribute aliases usable from
macro_apply. - macro_
derive_ alias - โ
Defines derive aliases usable from
macro_derive. - macro_
dollar - โ
Provides a literal
$token to a macro body. - map
- ๐๏ธ ๐๏ธ Defines a custom static hashmap.
- maybe
- โ ๐คท
Macro helper for using optionally implemented traits, like
DefaultorClone. - maybe_
slot - โ ๐คท โ๏ธ Expands to a primitive slot from either a direct carrier or a wrapped outer type.
- methods_
as_ fns - โ Defines standalone functions that call associated methods.
- mod_
from - โ Declares a module by including a Rust source file relative to the projectโs directory.
- mod_
path - โ A macro helper to define a module name and path.
- morph
- โ ๐ฑ Morphs a value through one or more transformation steps and returns the result.
- niche
- โ โ๏ธ ๐๏ธ Creates a primitive-backed niche value with compile-time type selection.
- niche_
prim - โ๏ธ โ๏ธ Maps a niche representation type to its primitive carrier type.
- offset_
of - ๐ซ
coreExpands to the offset in bytes of a field from the beginning of the given type. - option_
env - โ
coreOptionally inspects an environment variable at compile time. - ori
- ๐ ๐งญ ๐๏ธ
Constructs an
Orientationwith inferred dimensionality. - panic_
- โ
corePanics the current thread. - paste
- โ proc Allows to paste identifiers together.
- pin
- โ ๐ซ ๐
coreConstructs aPin<&mut T>, by pinning avalue: Tlocally. - pos
- ๐ ๐๏ธ
Constructs a
Positionwith inferred dimensionality. - punroll
- โ
Compile-time pattern unroll over a width of
0..=8 || pow(2) <= 64. - rand_
pcg - ๐๏ธ ๐ฒ Defines a canonical PCG (Permuted Congruential Generator) PRNG type.
- rand_
xorshift rand - ๐๏ธ ๐ฒ Constructs a XorShift prng with custom bits, basis, triplet and seed.
- read_at
- โ ๐ซ Read values from a buffer at an explicit offset.
- region
- ๐ ๐๏ธ
Constructs a
Regionfrom aPositionand anExtent. - repeat
- โ proc Repeats an expression the given number of times, as duplicated code with no loops.
- set
- ๐๏ธ โ โซ๏ธ Defines a compact set backed by an integer bit mask.
- set_
panic_ handler - โ ๐ฅ๏ธ Sets a panic handler based on the chosen strategy.
- sf
- โ ๐น
skipformatting macro. - size_
of_ expr - โ ๐ซ Returns the size of an expression in bytes.
- sleep4
linuxorstd - ๐งต ๐ A more compact thread sleep.
- slice
- ๐ ๏ธ
Invokes
Slicerange methods using short notation. - slog
unsafe_sync - ๐ชต Static global logger macro, compile-time friendly.
- stringify
- โ ๐
coreStringifies its arguments. - structural_
mods - โ Defines a standardized module structure for organizing visibility and re-exports.
- test_
size_ of - ๐ฏ ๐ซ Tests the stack size of a type.
- thread_
local std - ๐งต โ
stdDeclare a new thread local storage key of typeThreadLocalKey. - todo
- โ
coreIndicates unfinished code. - type_
count - โ Returns the total number of types received.
- type_
marker - โ ๐ซ ๐๏ธ Defines zero-cost, zero-sized, generic marker IDs.
- type_
resource - โ ๐ซ ๐๏ธ Defines zero-cost, zero-sized, type-safe resource IDs.
- unimplemented
- โ
coreIndicates unimplemented code. - unreachable
- โ
coreIndicates unreachable code. - unroll
_unroll - โ cgen Unrolls the given for loop.
- unwrap
- โ๏ธ An unwrapper macro that works in compile-time.
- use_as
- โ Imports families of prefixed items under shorter local names.
- vec_
alloc - ๐๏ธ ๐๏ธ
allocCreates aVeccontaining the arguments. - whilst
- โ
A flexible loop constructor supporting both
while- andfor-style syntaxes. - word
- ๐ชช โฃ ๐๏ธ Defines a transparent word type over a raw representation.
- write
- ๐น
coreWrites formatted data into a buffer. - write_
at - โ ๐ซ Write elements into a buffer at an explicit offset.
- writeln
- ๐น
coreWrites formatted data into a buffer, with a newline appended.
Structsยง
- Addr
Parse Error - ๐ก ๐ฉ
coreAn error which can be returned when parsing an IP or socket address. - Adler32
- ๐ Adler-32 checksum.
- Alloc
- ๐งบ ๐ ๏ธ Memory-allocation-related operations.
- Alsa
alsa - ๐ ๐ง ๐ ๏ธ ALSA operations.
- Alsa
PcmHandle alsa - ๐ ๐ง ๐ Owned ALSA PCM stream handle.
- Angle
- ๐ An angle represents a fraction of a full rotation.
- Ansi
term - ๐ฎ ๐ ๏ธ ANSI escape codes.
- Ansi
Color8 term - ๐ฎ ๐จ ANSI 8-bit color codes, 256 colors.
- Ansi
Link term - ๐ฎ ๐ ๐งถ A terminal hyperlink using the OSC 8 escape sequence.
- AnsiOsc
term - ๐ฎ ๐งถ An OSC sequence with semicolon-separated fields.
- AppApple
std - ๐ Apple enviroment for directories.
- AppConfig
std - ๐ฅ๏ธ Application specific metadata.
- AppControl
Set - โฌก ๐ถ โ A set of application control notices.
- AppUnix
std - ๐ Unix enviroment for directories.
- AppWindows
std - ๐ช Windows enviroment for directories.
- AppXdg
std - ๐ง Xdg enviroment for directories.
- Arc
alloc - ๐งต โ๏ธ ๐
?allocA thread-safe reference-counting pointer. - ArcWeak
alloc - ๐งต โ๏ธ ๐
?allocA version ofArcthat holds a non-owning reference. - Arch
- ๐ฅ๏ธ ๐ ๏ธ Arch-related functionality.
- Arena
Example - โจ ๐งบ An example memory arena.
- Arena
Handle Example - โจ ๐งบ An example memory arena handle.
- Arena
Mark Example - โจ ๐งบ An example memory arena mark.
- Array
- ๐๏ธ A static 1-dimensional array backed by the core array primitive.
- Array2d
- ๐๏ธ
A static 2-dimensional
Array. - Array
Fmt - ๐น ๐๏ธ
A formatting wrapper for core arrays, implementing
DisplayandDebug. - Array
From - ๐ฑ ๐ซ Compile-time conversion from slice-like types to arrays.
- Array
Uninit unsafe_array - ๐๏ธ A static array allowing uninitialized elements.
- Ascii
Lut - โ ๐ ๐ ๏ธ A text-related LUT namespace.
- Ascii
Set - ๐ โ A finite set of ASCII characters.
- Async
Context - ๐งต โฌก
coreThe context of an asynchronous task. - Async
RawWaker - ๐งต โฌก
coreAllows the implementor of a task executor to create aAsyncWaker. - Async
RawWakerV Table - ๐งต โฌก
coreA virtual fn pointer table that specifies the behavior of aAsyncRawWaker. - Async
Waker - ๐งต โฌก
coreA handle for waking up a task by notifying its executor that itโs ready to run. - Atomic
dep_atomic - ๐งต โ๏ธ
atomicA generic atomic wrapper type. - Atomic
Bool - ๐งต โ๏ธ
?coreA boolean type which can be safely shared between threads. - Atomic
F32 dep_portable_atomic - ๐งต โ๏ธ
portable-atomicA thread-safe floating-point type. - Atomic
F64 dep_portable_atomic - ๐งต โ๏ธ
portable-atomicA thread-safe floating-point type. - Atomic
I8 dep_portable_atomic - ๐งต โ๏ธ
?coreA thread-safe signed integer type. - Atomic
I16 dep_portable_atomic - ๐งต โ๏ธ
?coreA thread-safe signed integer type. - Atomic
I32 dep_portable_atomic - ๐งต โ๏ธ
?coreA thread-safe signed integer type. - Atomic
I64 dep_portable_atomic - ๐งต โ๏ธ
?coreA thread-safe signed integer type. - Atomic
I128 dep_portable_atomic - ๐งต โ๏ธ
portable-atomicA thread-safe signed integer type. - Atomic
Isize dep_portable_atomic - ๐งต โ๏ธ
?coreA thread-safe signed integer type. - Atomic
Ptr dep_portable_atomic - ๐งต โ๏ธ
?coreA raw pointer type which can be safely shared between threads. - Atomic
U8 dep_portable_atomic - ๐งต โ๏ธ
?coreA thread-safe signed integer type. - Atomic
U16 dep_portable_atomic - ๐งต โ๏ธ
?coreA thread-safe signed integer type. - Atomic
U32 dep_portable_atomic - ๐งต โ๏ธ
?coreA thread-safe signed integer type. - Atomic
U64 dep_portable_atomic - ๐งต โ๏ธ
?coreA thread-safe signed integer type. - Atomic
U128 dep_portable_atomic - ๐งต โ๏ธ
portable-atomicA thread-safe unsigned integer type. - Atomic
Usize dep_portable_atomic - ๐งต โ๏ธ
?coreA thread-safe signed integer type. - Audio
Device - ๐ ๐ Borrowed description of an audio endpoint.
- Audio
Device Cow alloc - ๐ ๐ Owned or borrowed description of an audio endpoint.
- BTree
Map alloc - ๐๏ธ โค
allocAn ordered map based on a B-Tree. - BTree
Set alloc - ๐๏ธ โค โ
allocAn ordered set based on a B-Tree. - Backtrace
std - ๐
stdA captured OS thread stack backtrace. - BareBox
- โ
๐ซ
A no-op pointer type, like a
Boxbut without affecting howTis stored. - Barrier
std - ๐งต
stdEnables multiple threads to synchronize the beginning of some computation. - Barrier
Wait Result std - ๐งต โ๏ธ
stdReturned byBarrier::wait()when all threads in it have rendezvoused. - Base
- ๐ฅก A compile-time configurable radix-based encoding scheme.
- BinTag4
- ๐ชช ๐ฅก A fixed four-byte binary tag.
- Binary
Heap alloc - ๐๏ธ
allocA priority queue implemented with a binary heap. - BitSpan
- โซ๏ธ ๐๏ธ A contiguous span of bits in an integer carrier.
- Bitfield
Example _docs_examplesand (_docs_examples) - โจ โซ๏ธ ๐ซ ๐๏ธ A compact packet header.
- Bitwise
- โ
๐ ๏ธ
Provides constant bitwise operations on
T. - Box
alloc - ๐ซ
allocA pointer type that uniquely owns a heap allocation of typeT. - Boxed
alloc - ๐ซ
A zero-sized marker for a
Storagetype that wraps its data in aBox. - Buffer
Linear Alloc Example _docs_examplesandalloc - โจ ๐๏ธ
An owned linear buffer over a
Vec, made withbuffer_linear!. - Buffer
Linear Static Example _docs_examples - โจ ๐๏ธ
A static linear buffer over contiguous storage, made with
buffer_linear!. - Buffer
Linear View Example _docs_examples - โจ ๐๏ธ A linear buffer view over contiguous storage, made with buffer_linear!.
- Buffer
Ring Static Example _docs_examples - โจ ๐๏ธ
A static ring buffer over contiguous storage, made with
buffer_ring!. - Bump
Alloc allocandunsafe_layout - ๐งบ A simple, single-threaded bump allocator.
- Byte
Cursor - ๐ชช ::=
A byte-position cursor over storage
S. - Byte
Search - ๐ ::= ๐ ๏ธ A utility struct for searching bytes in slices.
- CStr
- ๐ ๐
coreRepresentation of a borrowed C string (SeeCString). - CString
alloc - ๐
allocAn owned, C-compatible, nul-terminated string with no nul bytes in the middle. - Cache
Align - ๐ซ Aligns and pads a value to the length of a cache line.
- Call
Semantics - โฆ Structural semantics of a call edge.
- Cast
- โ โ๏ธ ๐ ๏ธ Provides const casting, joining and splitting operations between primitives.
- Cell
- ๐ซ
coreA mutable memory location. - Char
- ๐ ๐ ๏ธ Unicode scalars-related low-level const operations.
- Char
Iter - ๐ ๐ An iterator over Unicode scalars.
- Cmp
- โง โค ๐ ๏ธ
Provides comparing methods for
T. - Code
Location - โ A precise location in the source code.
- Code
Span - โ A contiguous span between two code locations.
- Command
std - ๐ฅ๏ธ โฌก
stdA builder for configuring and spawning new processes. - Command
Args std - ๐ฅ๏ธ โฌก
stdAn iterator over the command arguments. - Command
Envs std - ๐ฅ๏ธ โฌก
stdAn iterator over the command environment variables. - Command
Flow std - ๐ฅ๏ธ โฌก An executable flow of OS process invocations.
- Condvar
std - ๐งต
stdA Condition Variable. - Const
List - ๐๏ธ ๐ An immutable, append-only, linear, functional, non-contiguous, list.
- Const
List Iter - ๐ ๐
Iterates over the contents of a
ConstList. - Coro
Manager alloc - ๐งต โฌก
A managed dynamic collection of single-thread
CoroWorkercoroutines. - Coro
Work - ๐งต โฌก
A future that alternates between
ReadyandPendingstatus each time itโs polled. - Coro
Worker - ๐งต โฌก Represents a single-thread stackless coroutine worker.
- Crockford
- ๐ฅก
The
CrockfordBase32encoding, case-insensitive, remaps certain characters. - Current
stdandunsafe_layout - ๐
A marker object representing the current instance of a type
T. - Current
Guard stdandunsafe_layout - ๐
A guard that temporarily sets a global current ptr for
T, restoring the old one on drop. - Cycle
- ๐ A repeating cycle defined by a fundamental period.
- Cycle
Count - ๐ A cycle that repeats a fixed number of times.
- Debug
List - ๐น ๐
coreA struct to help withDebugimplementations. - Debug
Map - ๐น ๐
coreA struct to help withDebugimplementations. - Debug
Set - ๐น ๐
coreA struct to help withDebugimplementations. - Debug
Struct - ๐น ๐
coreA struct to help withDebugimplementations. - Debug
Tuple - ๐น ๐
coreA struct to help withDebugimplementations. - Debug
With - A
Debugadapter for formatting a value with aDebugExtcontext. - Destaque
_destaqueยทยท - ๐๏ธ
A static double-ended queue and stack backed by an
Array. - Destaque
Iter _destaqueยทยท - ๐
An iterator over
Destaqueelements. - Device
Id event - ๐ฎ ๐ซ A backend-agnostic identifier for an input device.
- Digest
- ๐ ๐ A fixed-size message digest.
- Digits
- ๐ โ ๐ ๏ธ Provides ASCII digit operations and conversions for unsigned integer primitives.
- DirBuilder
std - ๐
stdA builder used to create directories in various manners. - DirEntry
std - ๐
stdEntries returned by the ReadDir iterator. - Discriminant
- ๐ซ
coreOpaque type representing the discriminant of an enum. - Distance
- ๐
A separation between two locations in
D-dimensional space. - Divisor
Example _docs_examples - โจ โ
An example divisor helper generated by
divisor!. - 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 a
DstQueue. - DstQueue
Iter Mut unsafe_layout - ๐
A mutable iterator over the elements of a
DstQueue. - DstQueue
PopGuard unsafe_layout - ๐
Guard returned by
DstQueue::pop - DstStack
unsafe_layout - ๐๏ธ A statically allocated LIFO stack of DSTs.
- DstStack
Iter unsafe_layout - ๐
An iterator over the elements of a
DstStack. - DstStack
Iter Mut unsafe_layout - ๐
A mutable iterator over the elements of a
DstStack. - DstValue
unsafe_layout - ๐๏ธ A statically allocated DST value.
- Duration
- ๐
coreA span of time, withu64seconds andu32nanoseconds. - Duration
Error TryFrom Float Secs - ๐ ๐ฉ
coreError returned from converting floating-point seconds into aDuration. - Element
NotFound - ๐ชช ๐ฉ The requested element has not been found.
- Enum
SetExample docortest - โจ โ โ
An example set of enum variants, generated with
enumset!. - Env
- ๐ ๏ธ
A namespaced wrapper for
std::envfunctions and constants. - Event
event - ๐ซ A fully-typed event with optional timing and metadata.
- Event
Buttons event - ๐ซ ๐ฎ โ A semantic bitmask of currently held pressable buttons.
- Event
Key event - ๐ซ ๐ฎ Represents a keyboard event.
- Event
KeyFfi ffiยทยท - ๐ซ ๐ฎ ๐ก๏ธ
An FFI-safe version of
EventKey. - Event
Mouse event - ๐ซ ๐ฎ Represents a basic mouse event.
- Event
Pointer event - ๐ซ ๐ฎ Represents a pointer event (mouse, touch, or pen).
- Event
Queue event - ๐ซ ๐๏ธ
A tiny, zero-alloc FIFO queue for
Event. - Event
TagSet event - ๐ซ ๐๏ธ
A compact set of
EventTags. - Event
Timestamp event - ๐ซ ๐ The time at which the event occurs, stored as single-precision milliseconds.
- Event
Wheel event - ๐ซ ๐ฎ Represents a normalized wheel-scroll event.
- Exit
Code std - ๐ฅ๏ธ โฌก โ๏ธ
stdThe status code the process returns to its parent on normal termination. - Exit
Status std - ๐ฅ๏ธ โฌก โ๏ธ
stdDescribes the result of a process after it has terminated. - Exit
Status Error std - ๐ฅ๏ธ โฌก ๐ฉ Indicates that a process terminated unsuccessfully.
- Extent
- ๐
An orthogonal extension in
D-space without a coordinate position. - Failed
Error Conversion - ๐ฑ ๐ฉ A failed conversion between two error types.
- False
- โ โง A type-level logical false.
- FatPtr
unsafe_layout - ๐ซ Represents a fat pointer with separate data and metadata pointers.
- FdBorrowed
std - ๐ ๐
stdA borrowed file descriptor. - FdOwned
std - ๐ ๐
stdAn owned file descriptor. - File
std - ๐
stdAn object providing access to an open file on the filesystem. - File
Metadata std - ๐
stdMetadata information about a file. - File
Open Options std - ๐
stdOptions and flags which can be used to configure how a file is opened. - File
Permissions std - ๐
stdRepresentation of the various permissions on a file. - File
Times std - ๐
stdRepresentation of the various timestamps on a file. - File
Type std - ๐
stdRepresents a type of file with accessors for each file type. - Float
- โ
๐ ๏ธ ยฑstd
Provides comprehensive floating-point operations for
T, most of them const. - Fmt
- ๐ ๐ ๏ธ A string formatting namespace.
- FmtArguments
- ๐น
coreRepresents a safely precompiled version of a format string and its arguments. - FmtError
- ๐น ๐ฉ
coreThe error type which is returned from formatting a message into a stream. - FmtFrom
Fn - ๐น
coreImplementsDebugandDisplayvia the provided closure. - FmtNum
- ๐น โ Const number formatter.
- FmtNum
Conf - ๐น โ Configuration for numeric formatting.
- FmtNum
Group - ๐น โ Numeric digit grouping configuration.
- FmtNum
Shape - ๐น โ Describes the structural shape of a formatted number.
- FmtWriter
- ๐น A specialized formatter with a fixed byte buffer and truncation detection.
- FontArt
font - ๐ ต A simple Unicode-Art font for rendering fixed-size glyphs.
- Font
Bitmap font - ๐ ต A fixed-size bitmap font packed into glyph words.
- Formatter
- ๐น
coreConfiguration for formatting. - Frac
int - โ
๐ ๏ธ
Provides comprehensive fractional operations on
T, most of them const. - From
Utf8 Error alloc - ๐ ๐ฉ
allocA possible error value when converting a String from a UTF-8 byte vector. - Fs
std - ๐ ๐ ๏ธ Filesystem-related operations.
- FsPath
std - ๐ ๐ ๏ธ
A more featureful wrapper over
PathBuf. - Future
Pending - ๐งต โฌก
coreA future which never resolves, representing a never finishing computation. - Future
Poll Fn - ๐งต โฌก
coreA Future that wraps a function returningAsyncPoll. - Future
Ready - ๐งต โฌก
coreA future that is immediately ready with a value. - Game
Action - ๐ A declared move or operation recognized by the rules of play.
- Game
Cycle - ๐ A repeated structural grouping of turns, phases, or recurrent play segments.
- Game
Legacy - ๐ Persistent continuity that carries across multiple sessions of play.
- Game
Outcome - ๐ โ๏ธ A resolved result recognized by the rules of play.
- Game
Phase - ๐ A named subdivision within a turn or cycle of play.
- Game
Role - ๐ A rule-bearing identity or seat in play.
- Game
Session - ๐ A bounded instance of enacted play.
- Game
Turn - ๐ A bounded opportunity for one role or control locus to act.
- Gamma
color - ๐จ Gamma correction curves.
- GcdReturn
- โ โ๏ธ A return type for the calculated GCD and the Bรฉzout coeficients.
- Grapheme
Machine grapheme - ๐ Streaming EGC boundary detector. Streaming grapheme cluster boundary detector.
- Grapheme
Nonul grapheme - ๐
An EGC backed by a
StringNonul. - Grapheme
Props grapheme - ๐ Combined EGC break properties for a single code point.
- Grapheme
Scanner grapheme - ๐ ๐ Scans text and detects grapheme cluster boundaries during iteration.
- Grapheme
String allocandgrapheme - ๐
An EGC backed by a
String. - Grapheme
U8 grapheme - ๐
An EGC backed by a
StringU8. - Handle
Span Example _docs_examples - โจ ๐ซ
An example handle generated by
handle!. - HashMap
dep_hashbrownorstd - ๐๏ธ ๐
โกstdAn unordered hash map with quadratic probing and SIMD lookup. - HashSet
dep_hashbrownorstd - ๐๏ธ ๐ โ
โกstdAn unordered hash set implemented as aHashMapwhere the value is() - Hasher
Build Default - ๐
coreCreate a defaultHasherBuildinstance forT:Hasher+Defaulttypes. - Hasher
Fnv hash - ๐ A FowlerโNollโVo hasher, implemented for u32, u64, u128 & usize.
- Hasher
Fx - ๐ A hashing algorithm used in the Rustc compiler, implemented for u32, u64 & usize.
- Hasher
Pengy hash - ๐ A fast 64-bit non-cryptographic hash algorithm.
- Http
http - ๐ก โ HTTP protocol operations.
- Http
Request Line http - ๐ก โ ::= ๐ Borrowed HTTP request line.
- Http
Response Head http - ๐ก โ HTTP response head.
- Http
Status http - ๐ก โ HTTP response status code.
- IdPin
- ๐ซ ๐งบ A unique identifier based on a pinned stack-allocated reference.
- IdPin
Box alloc - ๐ซ ๐งบ A unique identifier based on a pinned heap-allocated memory address.
- IdRegistry
- ๐ซ Maps backend/native identifiers into stable, compact internal IDs.
- IdSeq
Usize Example docortest - โจ ๐ซ ๐๏ธ
A unique sequential identifier
usizegenerator. - Incompatible
Bounds - โ ๐ฉ The given bounds are incompatible. E.g. lower bound exceeds upper bound.
- Index
OutOf Bounds - ๐ชช ๐ฉ The given index is out of bounds.
- Int
int - โ
๐ ๏ธ
Provides comprehensive integer operations on
T, all of them const. - Interval
- ๐
A range of values with
lowerandupperBounds. - Invalid
Axis Length - ๐ชช ๐ฉ The given axis has an invalid length.
- Invalid
Char - ๐ ๐ฉ An invalid given character was found.
- Invalid
Utf8 - ๐งถ ๐ฉ Invalid UTF-8 found while interpreting a byte sequence.
- Invalid
Value - ๐ฑ ๐ฉ An invalid value was received for the given type or operation.
- Io
std, orioand non-std - ๐ ๐ ๏ธ I/O-related operations.
- IoBuf
Reader - ๐
?stdAdds buffering to any reader. - IoBuf
Writer - ๐
?stdWraps a writer and buffers its output. - IoBytes
- ๐
?stdAn iterator overu8values of a reader. - IoChain
- ๐
?stdAdapter to chain together two readers. - IoCursor
- ๐
?stdWraps an in-memory buffer and provides it with anIoSeekimplementation. - IoEmpty
- ๐
?stdIgnores any data written viaIoWrite, and read viaIoRead. - IoError
- ๐
๐ฉ+
?stdError type forIoRead,IoWrite,IoSeekoperations. - IoInto
Inner Error std - ๐
๐ฉ
stdAn error returned byIoBufWriter::into_inner - IoLine
Writer - ๐
?stdLikeBufWriter, but flushing whenever a newline (0x0a,' ') is detected. - IoLines
std - ๐
stdAn iterator over the lines of an instance ofIoBufRead. - IoPipe
Reader std - ๐
stdRead end of an anonymous pipe. - IoPipe
Writer std - ๐
stdWrite end of an anonymous pipe. - IoRepeat
- ๐
?stdA reader which yields one byte over and over and over and over and over andโฆ - IoSink
std - ๐
stdA writer which will move data into the void. - IoSlice
std - ๐
stdA buffer type used withIoWrite::write_vectored. - IoSlice
Mut std - ๐
stdA buffer type used withIoRead::read_vectored. - IoSplit
std - ๐
stdAn iterator over the contents of an instance of BufRead split on a particular byte. - IoTake
- ๐
?stdReader adapter which limits the bytes read from an underlying reader. - Ipv4
Addr - ๐ก
coreAn IPv4 address. - Ipv6
Addr - ๐ก
coreAn IPv6 address. - Iter
- ๐ ๐ ๏ธ Iterator-related namespaced operations.
- Iter
Args OsRef stdandunsafe_ffi - ๐ ๐
โ ๏ธIterator over references of command line arguments. - Iter
DirRead std - ๐ ๐
stdIterator over the entries in a directory. - Join
Paths Error std - ๐ฉ ๐ฅ๏ธ
stdReturned fromEnv::join_paths. - Js
js - โฌก ๐ ๏ธ Javascript-related operations.
- JsConsole
jsandunsafe_ffi - โฌก ๐ ๏ธ Javascript Console.
- JsInstant
js - โฌก ๐
A high-resolution timestamp based on JavaScriptโs
performance.now(). - JsText
Render Metrics js - โฌก ๐ ๐งฑ Text Metrics.
- JsText
Render Metrics Full js - โฌก ๐ ๐งฑ Full Text Metrics.
- JsTimeout
js - โฌก ๐ ๐ซ A handle to a JavaScript timeout.
- KeyAlready
Exists - ๐ชช ๐ฉ The key already exists.
- KeyMods
event - ๐ฎ โ A bitfield of key modifiers (Shift, Controlโฆ) + extra (repeating, composing).
- LINUX_
ERRNO linux - ๐ง ๐ฉ+
Linuxsys/errno.hconstants. - LINUX_
EXIT linux - ๐ง โ๏ธ Standard exit codes for Linux processes
- LINUX_
FILENO linux - ๐ง ๐
LinuxStandard file descriptor numbers. - LINUX_
F_ CMD linux - ๐ง ๐
LinuxFile descriptor commands (forfcntl). - LINUX_
IOCTL linux - ๐ง ๐
Linux
ioctlconstants. - LINUX_
O_ FLAGS linux - ๐ง ๐
Linuxfile creation and status flags. - LINUX_
SEEK linux - ๐ง ๐
LinuxSeek commands (forlseek). - LINUX_
S_ IFMT linux - ๐ง ๐
LinuxFile mode and permission bits. - Lane4_
i32Example _docs_examples - โจ โ โ
Example fixed-width pack of 4 ร
i32lanes. - Lazy
Cell - ๐ซ ๐ฑ
coreA value which is initialized on the first access. - Lazy
Lock std - ๐งต ๐ฑ
stdA value which is initialized on the first access. - Lcg16
rand - ๐ฒ A 16-bit LCG PRNG.
- Libc
unsafe_ffi - ๐ฅ๏ธ ๐ ๏ธ Raw C/POSIX system interfaces exposed through the platformโs libc.
- Linked
List alloc - ๐๏ธ
allocA doubly-linked list with owned nodes. - Linux
linux - ๐ง ๐ ๏ธ Linux-related operations.
- Linux
Instant linux - ๐ง ๐ A fast monotonic Linux time source.
- Linux
Mmap Alloc Linux and allocandunsafe_layoutand (stdorunsafe_ffi) - ๐ง ๐งบ
A Linux global memory allocator backed directly by anonymous
mmap. - Linux
Sigaction linux - ๐ง ๐ถ ๐ป Examine and change a signal action.
- Linux
Sigaction Flags linux - ๐ง ๐ถ โ
Input flags for
LinuxSigaction. - Linux
Siginfo linux - ๐ง ๐ถ ๐ป Additional information about a signal.
- Linux
Signal Set linux - ๐ง ๐ถ โ A compact semantic set of standard Linux signals.
- Linux
Sigset linux - ๐ง ๐ถ โ ๐ป A raw Linux kernel signal mask.
- Linux
Sparse Set _linux_abiandunsafe_ffi - ๐๏ธ ๐ฅ๏ธ โ A Linux mmap-backed sparse set with lazily zeroed storage.
- Linux
Stat linux - ๐ง ๐ ๐ป File status structure matching libcโs stat (man 2 stat)
- Linux
Termios linux - ๐ง ๐ฎ ๐ป
Represents the
termiosstructure from libc, used to control terminal I/O. - Linux
Termios Cc linux - ๐ง ๐ฎ
A symbolic index into
LinuxTermios::c_cc. - Linux
Termios Control Flags linux - ๐ง ๐ฎ โ
LinuxTermioscontrol flags. - Linux
Termios Input Flags linux - ๐ง ๐ฎ โ
LinuxTermiosinput flags. - Linux
Termios Local Flags linux - ๐ง ๐ฎ โ
LinuxTermioslocal flags. - Linux
Termios Output Flags linux - ๐ง ๐ฎ โ
LinuxTermiosoutput flags. - Linux
Time linux - ๐ง ๐ A configurable family of Linux clocks.
- Linux
Timespec linux - ๐ง ๐ ๐ป
Represents the
timespecstructure from libc. Time in seconds and nanoseconds. - Logger
Static - ๐ชต Fixed-capacity static logger with owned byte buffers.
- Lum
color - ๐จ A generic luminance-like component.
- Manually
Drop - ๐ซ
coreA wrapper to inhibit compiler from automatically callingTโs destructor. - MapStatic
Const U8Example - โจ ๐๏ธ
A fully
conststatic hashmap with compile-timeu8keys. - MapStatic
Type IdExample - โจ ๐๏ธ
A
TypeId-keyed static hashmap. - MapStatic
U16Example - โจ ๐๏ธ
A runtime static hashmap with stored
emptyandtombmarkers. - Matrix
lin - โ
A static
RรCshaped matrix backed by an array. - Maybe
Niche - ๐คท โ๏ธ A zero-cost wrapper that abstracts over niche and non-niche types.
- Md5
_docs_examples - โจ ๐ ๐ Incremental Md5 state.
- Mem
- ๐ซ ๐ ๏ธ Memory-related operations.
- MemHedge
Ctrl - ๐ซ ๐งต โ๏ธ Shared control plane for one hedged read request at a time.
- MemHedge
Read - ๐ซ ๐งต ๐ โฌก Binds a hedge-control cell to a replicated logical slice view.
- MemLayout
alloc - ๐งบ
allocLayout of a block of memory. - MemLayout
Error alloc - ๐งบ ๐ฉ
allocTheMemLayoutparameters violated constraints. - MemReplica
Slice - ๐ซ ๐ Mutable replicated view over a backing slice.
- Mismatch
- โ๏ธ
Represents a mismatch between an expected
needand an encounteredhave. - Mismatched
Capacity - ๐ชช ๐ฉ The operation did not satisfy a finite capacity constraint.
- Mismatched
Dimensions - ๐ชช ๐ฉ The dimensions given did not match the elements provided.
- Mismatched
Indices - ๐ชช ๐ฉ The given indices does not match the expected order.
- Mismatched
Sizes - โ ๐ฉ The provided values are not compatible in size.
- Mpsc
- ๐งต ๐ ๏ธ Multi-producer, single-consumer channel operations.
- Mpsc
Into Iter std - ๐งต ๐
stdAn owning iterator over messages on anMpscReceiver. - Mpsc
Iter std - ๐งต ๐
stdAn iterator over messages on anMpscReceiver - Mpsc
Receive Error std - ๐งต ๐ฉ
stdAn error returned fromMpscReceiver::recv. - Mpsc
Receiver std - ๐งต
stdThe receiving half of anMpscchannelorsync_channel. - Mpsc
Send Error std - ๐งต ๐ฉ
stdAn error returned fromMpscSender::sendorMpscSyncSender::send. - Mpsc
Sender std - ๐งต
stdThe sending half of an asyncMpscchannel. - Mpsc
Sync Sender std - ๐งต
stdThe sending half of a syncMpscchannel. - Mpsc
TryIter std - ๐งต ๐
stdAttempts to yield all pending values for anMpscReceiver. - Mutex
std - ๐งต
stdA mutual exclusion primitive useful for protecting shared data. - Mutex
Guard std - ๐งต ๐
stdAn RAII implementation of a โscoped lockโ of a mutex. - NoInverse
- โ ๐ฉ An inverse doesnโt exist.
- Node
Empty - ๐ชช โค ๐ฉ The node is empty.
- Node
Link NotSet - ๐ชช ๐ฉ The node link is not set.
- Node
Link NotUnique - ๐ชช ๐ฉ The node link is not unique.
- NonNegative
Required - โ ๐ฉ A non-negative value is required.
- NonNiche
- โ โ๏ธ A zero-cost wrapper that mimics a niche type without using a niche.
- NonValue
I8 - โ โ๏ธ A signed integer that is known not to equal some specific value.
- NonValue
I16 - โ โ๏ธ A signed integer that is known not to equal some specific value.
- NonValue
I32 - โ โ๏ธ A signed integer that is known not to equal some specific value.
- NonValue
I64 - โ โ๏ธ A signed integer that is known not to equal some specific value.
- NonValue
I128 - โ โ๏ธ A signed integer that is known not to equal some specific value.
- NonValue
Isize - โ โ๏ธ A signed integer that is known not to equal some specific value.
- NonValue
U8 - โ โ๏ธ An unsigned integer that is known not to equal some specific value.
- NonValue
U16 - โ โ๏ธ An unsigned integer that is known not to equal some specific value.
- NonValue
U32 - โ โ๏ธ An unsigned integer that is known not to equal some specific value.
- NonValue
U64 - โ โ๏ธ An unsigned integer that is known not to equal some specific value.
- NonValue
U128 - โ โ๏ธ An unsigned integer that is known not to equal some specific value.
- NonValue
Usize - โ โ๏ธ An unsigned integer that is known not to equal some specific value.
- NonZero
- โ
โ๏ธ
coreA value that is known not to equal zero. - NonZero
Required - โ ๐ฉ A non-zero value is required.
- NotEnough
Elements - ๐ชช ๐ฉ There are not enough elements for the operation.
- NotEnough
Space - ๐ชช ๐ฉ There is not enough free space for the operation.
- NotImplemented
- โ ๐ฉ The requested functionality is not implemented.
- NotSupported
- โ ๐ฉ The requested functionality is not supported by this type.
- Once
std - ๐งต
stdA synchronization primitive for one-time global initialization. - Once
Cell - ๐ซ ๐ฑ
coreA cell which can nominally be written to only once. - Once
Lock std - ๐งต
stdA synchronization primitive which can be written to only once. - Once
State std - ๐งต
stdState yielded toOnce::call_once_force()โs closure parameter. - Option
Fmt - ๐น
The type returned from
OptionExt::fmt_or_empty. - Option
FmtOr - ๐น
The type returned from
OptionExt::fmt_or. - Option
FmtOr Else - ๐น
The type returned from
OptionExt::fmt_or_else. - Order
- โ ๐งฑ ๐ ๏ธ Unified namespace for multi-dimensional ordering schemes.
- Orientation
- ๐ ๐งญ
A unitless directional vector in
D-dimensional space. - OsStr
std - ๐ ๐ ๐ฅ๏ธ
stdBorrowed reference to an OS string (SeeOsString). - OsString
std - ๐ ๐ฅ๏ธ
stdA type for owned, mutable native strings, interconvertible with Rust strings. - Otp
- ๐ ๐ A generated one-time password code.
- Output
std - ๐ฅ๏ธ โฌก
stdThe output of a finished process. - Overflow
- โ ๐ฉ An arithmetic overflow error, with an optional associated sign.
- Own
- โ๏ธ
A return type encapsulating an owned state
Sand a valueV. - Panic
std - ๐ ๏ธ Panic-related operations.
- Panic
Assert Unwind Safe - โ ๐ฏ
coreA simple wrapper around a type to assert that it is unwind safe. - Panic
Hook Info std - โ
stdPassed tostd::panic::set_hookwhere panics can have arbitrary payloads. - Panic
Info - โ
corePassed to#[panic_handler]inno_std, carries a formatted message. - Panic
Location - โ
coreA struct containing information about the location of a panic. - Parse
Float Error - ๐ ::= โ
๐ฉ
coreAn error which can be returned when parsing an float. - Parse
IntError - ๐ ::= โ
๐ฉ
coreAn error which can be returned when parsing an integer. - Partially
Added - ๐ชช ๐ฉ The operation could only add a subset of the elements.
- Path
std - ๐ ๐
stdA slice of a path (akin tostr). - PathBuf
std - ๐
stdAn owned, mutable path (akin toString). - Path
Strip Prefix Error std - ๐ ๐ฉ
stdAn error returned fromPath::strip_prefixif the prefix was not found. - Path
Windows Prefix Component std - ๐ ๐ช
stdWraps a Windows path prefix as well as its unparsed string representation. - Pcg32
- ๐ฒ A 32-bit PCG PRNG.
- PcmBuf
audio - ๐ ๐ชช Typed PCM sample buffer over caller-chosen storage.
- PcmRaw
audio - ๐ ๐ฅก Headerless raw PCM operations.
- PcmRaw
Buf audio - ๐ ๐ชช Raw PCM byte buffer over borrowed or owned storage.
- PcmSpec
audio - ๐ Essential metadata describing a PCM audio stream.
- PcmWav
audio - ๐ ๐ฅก RIFF/WAVE operations for PCM-family audio.
- PcmWav
Buf audio - ๐ ๐ชช Parsed WAVE byte buffer over borrowed or owned storage.
- PcmWav
Fmt audio - ๐ ::=
Parsed WAVE
fmtchunk. - Phantom
Data - โ
coreZero-sized type used to mark things that โact likeโ they own aT. - Phantom
Pinned - โ
coreA marker type which does not implementUnpin. - Pin
- ๐ ๐ซ ๐
coreA pointer which pins its pointee in place. - Pinned
unsafe_ptr - ๐ซ ๐ A wrapper for structurally pinned data.
- Pnm
- ๐ผ๏ธ ๐ ๏ธ A collection of methods for encoding and decoding PNM bitmap formats.
- Point
- ๐
A coordinate position in
D-space without extent. - Points
- ๐
A static sequence of
ND-dimensionalPoints. - Poison
Error std - ๐งต ๐ฉ
stdA type of error which can be returned whenever a lock is acquired. - Position
- ๐
A location in
D-dimensional space. - Positive
Required - โ ๐ฉ A positive value is required.
- Process
std - ๐งต
stdRepresentation of a running or exited child process. - Process
Stderr std - ๐
stdA handle to a child processโs stderr. - Process
Stdin std - ๐
stdA handle to a child processโs standard input (stdin). - Process
Stdout std - ๐
stdA handle to a child processโs standard output (stdout). - Ptr
- ๐ซ ๐ ๏ธ Pointer-related operations.
- PtrNon
Null - ๐ซ โ๏ธ
core*mut Tbut non-zero and covariant. - Rand
Fake rand - ๐ฒ ๐ญ A test-friendly random source backed by a fixed sequence.
- Rand
Qualities - ๐ฒ โ Semantic qualities of a random source.
- Random
State std - ๐
stdThe default state forHashMapStd. - Range
- ๐
coreA range value bounded inclusively below and exclusively above (start..end). - Range
From - ๐
coreA range value bounded inclusively below (start..). - Range
Full - ๐
coreAn unbounded range (..). - Range
Inclusive - ๐
coreA range value bounded inclusively below and above (start..=end). - RangeTo
- ๐
coreA range bounded exclusively above (..end). - Range
ToInclusive - ๐
coreA range value bounded inclusively above (..=end). - Raster
Bytes Mut - ๐ผ๏ธ ๐ Borrowed mutable byte raster view with explicit row layout.
- Raster
Bytes Ref - ๐ผ๏ธ ๐ Borrowed byte raster view with explicit row layout.
- Raster
Format - ๐ผ๏ธ ๐งฑ Sample layout and color meaning of raster memory.
- Raster
Layout - ๐ผ๏ธ ๐งฑ Describes the extent and memory stepping of raster storage.
- Raster
Mut - ๐ผ๏ธ ๐ Borrowed mutable dense raster view over typed samples.
- Raster
Ref - ๐ผ๏ธ ๐ Borrowed dense raster view over typed samples.
- Ratio
- ๐ A generic ratio representing a proportional relationship between two values.
- Rc
alloc - ๐ซ ๐
allocA single-threaded reference-counting pointer. - RcWeak
alloc - ๐ซ ๐
allocA version ofRcthat holds a non-owning ref to the managed allocation. - Ref
- ๐
coreA wrapper type for an inmutably borrowed value from aRefCell<T> - RefCell
- ๐ซ ๐
coreA mutable memory location with dynamically checked borrow rules. - RefCell
Borrow Error - ๐ ๐ฉ
coreAn error returned byRefCell::try_borrow. - RefCell
Borrow MutError - ๐ ๐ฉ
coreAn error returned byRefCell::try_borrow_mut. - RefMut
- ๐
coreA wrapper type for a mutably borrowed value from aRefCell<T> - Region
- ๐
A
PositionedExtent. - Region
Strided - ๐
A
StridedRegiondefining structured traversal. - Reverse
- โ
โค
coreA helper struct for reverse ordering. - Rfc4648
- ๐ฅก
The
RFC 4648standard encoding, used inBase16,Base32, andBase64. - Rfc4648
Hex - ๐ฅก
The
RFC 4648hexadecimal-variant encoding, used inBase32. - Rgb
color - ๐จ RGB color with 3 channels.
- Rgba
color - ๐จ RGB+A color with 4 channels.
- Riff
- ๐ชช ๐ฅก RIFF tagged binary container operations.
- Riff
Chunk - ๐ชช ๐ฅก A borrowed RIFF chunk.
- Riff
Chunk Iter - ๐ชช ๐ฅก ๐ An iterator over borrowed RIFF chunks.
- RunCap
- โฌก
The capabilities supported by a
Runtime. - RunCap
Audio - โฌก ๐ Runtime audio capabilities.
- RunCap
Color - โฌก ๐จ Runtime color capabilities.
- RunCap
Image - โฌก ๐ผ๏ธ Runtime image capabilities.
- RunCap
Input - โฌก ๐ฎ โ Runtime input capabilities.
- RunCap
System - โฌก โ Runtime system capabilities.
- RunCap
Text - โฌก ๐ โ Runtime text capabilities.
- RunCap
Window - โฌก Runtime window capabilities.
- RunCycle
- โฌก Manages run phases and guards phase transitions.
- RunDriver
- โฌก Orchestrates stepwise runtime progression over a backend and an app.
- RunFrame
- โฌก ๐ A per-frame snapshot passed to rendering or other backend-facing work.
- RunPacer
- โฌก ๐ Controls presentation cadence independently of simulation.
- RunStep
- โฌก ๐ A per-step snapshot passed to app logic.
- RunSystem
Info alloc - โฌก Runtime system identity metadata.
- Runtime
- โฌก A handle to the live execution context of a running system.
- Runtime
Tick - โฌก ๐ A deterministic logical execution-time counter.
- RwLock
std - ๐งต
stdA reader-writer lock - RwLock
Read Guard std - ๐งต
stdRAII structure used to release the shared read access of a lock when dropped. - RwLock
Write Guard std - ๐งต
stdRAII structure used to release the exclusive write access of a lock when dropped. - Saturating
- โ
coreProvides intentionally-saturating arithmetic onT. - Scope
Guard - ๐ A general-purpose RAII guard that executes a callback on drop.
- Sha1
_docs_examples - โจ ๐ ๐ Incremental SHA-1 state.
- Sha256
_docs_examples - โจ ๐ ๐ Incremental SHA-256 state.
- Sha512
_docs_examples - โจ ๐ ๐ Incremental SHA-512 state.
- Shell
Lex shell - ๐ ::= Splits shell-like input into command words.
- Shell
Quote shell - ๐ ๐ Quotes shell words for command strings.
- Sixel
Char term - ๐ผ๏ธ ๐ฎ A sixel character.
- Sixel
Color term - ๐จ ๐ฎ Sixel color representation.
- Sixel
Encoder term - ๐ผ๏ธ ๐ฎ Encoder for Sixel graphics with fixed buffer output
- Sixel
Palette term - ๐จ ๐ฎ Palette of Sixel colors with fixed capacity.
- Sixel
Palette Iter term - ๐จ ๐ ๐ฎ
An iterator over
SixelPalettecolors. - Slice
- ๐ ๐ ๏ธ Slice-related operations, most of them const.
- Slice
Iter - ๐ ๐ A lending iterator over a shared slice.
- Slice
Iter Mut - ๐ ๐ A lending iterator over an exclusive slice.
- Socket
Addr V4 - ๐ก
coreAn IPv4 socket address. - Socket
Addr V6 - ๐ก
coreAn IPv6 socket address. - Sort
- ๐ ๏ธ โ
Provides sorting methods for arrays and slices of
T. - Sparse
SetArray - ๐๏ธ โ A sparse integer set with constant-time insertion, removal, lookup and clearing.
- Spin
Lock unsafe_sync - ๐งต A spinlock providing mutual exclusion without blocking.
- Spin
Lock Guard unsafe_sync - A guard that grants exclusive access to a
SpinLockvalue. - Split
Mix64 - ๐ฒ SplitMix64 pseudo-random number generator.
- Stack
_stackยทยท - ๐๏ธ
A static stack backed by an
Array. - Stack
Iter _stackยทยท - ๐
An iterator over
Stackelements. - StdRand
std - ๐ฒ Standard-library hash-random source.
- StdSystem
Time Error std - ๐ ๐ฉ
stdError returned fromSystemTimeduration_sinceandelapsed. - Stderr
std - ๐
stdA handle to the standard error stream of a process. - Stdin
std - ๐
stdA handle to the standard input stream of a process. - Stdio
std - ๐ฅ๏ธ โฌก ๐
stdSpecifies how to handle standard I/O streams inCommand. - Stdout
std - ๐
stdA handle to the global standard output stream of the current process. - Str
- ๐งถ ๐ ๏ธ A string slice namespace.
- StrBuf
- ๐งถ A borrowed UTF-8 string buffer over caller-provided bytes.
- Stride
- ๐ A step size for traversing dimensions or repetitions.
- Strided
Iter - ๐ Iterates over a slice using an affine index progression.
- Strided
Iter Mut - ๐ Iterates mutably over a slice using an affine index progression.
- String
alloc - ๐
allocA UTF-8โencoded, growable string. - String
Nonul - ๐งถ
A null-terminated UTF-8 string with up to
u8::MAXbytes capacity. - String
Small Alloc alloc - ๐งถ A UTF-8 string with inline storage and heap spillover.
- String
U8 - ๐งถ A UTF-8 string with fixed capacity that stores length explicitly.
- System
Alloc std - ๐งบ
stdThe default memory allocator provided by the operating system. - System
Instant std - ๐
stdA measurement of a monotonically nondecreasing clock. - System
Time std - ๐
stdA measurement of the system clock. - System
Time Error std - ๐
๐ฉ
Returned from
duration_sinceandelapsedonSystemTime. - TcpListener
std - ๐ก
stdA TCP socket server, listening for connections. - TcpStream
std - ๐ก
stdA TCP stream between a local and a remote socket. - Term
Caps term - ๐ฎ โฌก โ โซ๏ธ Terminal capability bits.
- Term
Color term - ๐ฎ ๐จ โซ๏ธ A packed terminal color and its composition mode.
- Term
Colors term - ๐ฎ ๐จ Packed foreground and background terminal colors.
- Term
Grid term - ๐ฎ ๐๏ธ A dense row-major grid of terminal-space elements.
- Term
Input Parser eventandterm - ๐ฎ ๐ซ ::= Parses terminal input bytes into normalized events.
- Term
Linux eventandlinuxandterm - ๐ฎ ๐ง Linux terminal frontend.
- Term
Mode term - ๐ฎ โฌก โ Terminal session mode request.
- TermPen
term - ๐ฎ ๐ ๐จ Reusable terminal style and colors for constructing elements.
- Term
Renderer term - ๐ฎ โฌก Terminal renderer over caller-provided byte-frame storage.
- Term
Session term - ๐ฎ ๐ Scoped terminal session guard.
- Term
Size term - ๐ฎ ๐งฑ ๐ก๏ธ The size of the terminal.
- Term
Style term - ๐ฎ ๐ โ A compact set of broadly supported terminal text styles.
- Term
Style Ext term - ๐ฎ ๐ โ A complete set of terminal text styles.
- Termel
term - ๐ฎ ๐ ๐จ ๐๏ธ A textual element with terminal style and colors.
- Termel
Meta term - ๐ฎ ๐ ๐งฑ โซ๏ธ
Compact terminal-cell occupancy metadata for a
Termel. - Text
Cursor - ๐ Continuation point within a caller-defined text traversal.
- Text
Index - ๐ ๐งฑ Position within a caller-defined text-oriented sequence.
- Text
Layout - ๐ ๐งฑ ๐ ๏ธ Text layout engine configuration.
- Text
Layout Span - ๐ ๐งฑ ๐ Mapping between a contiguous text range and its consumed inline space.
- Text
Layout Step - ๐ ๐งฑ โ๏ธ Result of a single text layout step.
- Text
Parse Error - ๐ ::= ๐ฉ A text parsing failure paired with its cursor location.
- Text
Range - ๐ A half-open range within a caller-defined text-oriented sequence.
- Text
Scanner - ๐ ::= A byte scanner over source text.
- Text
Symbol - ๐ ๐งฑ ๐ Layout participation record for a single text symbol.
- Textel
- ๐ ๐๏ธ A textual element carried by a rendering cell.
- Thread
std - ๐งต ๐ซ
stdA handle to a thread. - Thread
Access Error std - ๐งต ๐ฉ
stdAn error returned byThreadLocalKey::try_with. - Thread
Builder std - ๐๏ธ ๐งต
stdThread factory, which can be used to configure the properties of a new thread. - Thread
Id std - ๐งต ๐ซ
stdA unique identifier for a running thread. - Thread
Join Handle std - ๐งต
stdAn owned permission to join on a thread (block on its termination). - Thread
Local Key std - ๐งต
stdA thread local storage key which owns its contents. - Thread
Scope std - ๐งต
stdA scope to spawn scoped threads in. - Thread
Scoped Join Handle std - ๐งต
stdAn owned permission to join on a scoped thread (block on its termination). - Time
Delta - ๐
A signed duration of time, stored as an
(i64, i32)pair of secs and nanos. - Time
Fake target_has_atomic=64 - ๐ ๐ญ A test-friendly time source that allows manual control.
- Time
Fake Ref target_has_atomic=64 - ๐ ๐ญ
A borrowed configuration handle selecting a specific
TimeFaketimeline. - Time
Split - ๐ A full time split from years to nanoseconds.
- Time
Unix I64 time - ๐ 64-bit Unix time, supporting negative values.
- Time
Unix U32 time - ๐ 32-bit Unix time, supporting only non-negative values.
- Timecode
- ๐ Timecode splitting and formatting.
- Timed
- ๐ A value paired with a time-like companion.
- Timeout
- ๐ ๐ฉ The operation has exceeded the allowed execution time.
- Translit
- ๐ ๐ ๏ธ Lossy text transliteration utilities.
- True
- โ โง A type-level logical true.
- TryFrom
IntError - โ
๐ฉ
coreThe error type returned when a checked integral type conversion fails. - Tuple
Fmt _tuple - ๐น ๐
A formatting wrapper for
Tuples, implementingDisplayandDebug. - Tuple
Iter _tuple - โ ๐ cgen
An iterator over elements of a
Tuple. - Tuple
Iter Mut _tuple - โ ๐ ๐ cgen
An iterator over exclusive references to elements of a
Tuple. - Tuple
Iter Ref _tuple - โ ๐ ๐ cgen
An iterator over shared references to elements of a
Tuple. - TypeId
- โ ๐ซ
coreRepresents a globally unique identifier for a type. - Type
Resource - โ ๐ซ A newtype-based ID that associates a resource with its inner ID.
- UdpSocket
std - ๐ก
stdA UDP socket. - Unexpected
Eof - ๐ชช ๐ฉ The input ended before the operation could complete.
- Unsafe
Cell - ๐ซ
coreThe core primitive for interior mutability in Rust. - Value
Quant - ๐ โ๏ธ A value with associated quantification.
- Vec
- ๐๏ธ
allocA contiguous growable array. - VecDeque
alloc - ๐๏ธ
allocA double-ended growable queue. - VecPoints
alloc - ๐
A dynamic sequence of
D-dimensionalPoints. - Vector
lin - โ
A static
D-dimensional vector, backed by a primitivearray. - Version
- โ A compact three-part semantic version core.
- Version
Full - โ A semantic version with optional borrowed metadata.
- Wait
Timeout Result std - ๐งต โ๏ธ
stdWhether a timed wait on aCondvarreturned due to a time out or not. - Wasm
- โฌก ๐ ๏ธ A Wasm namespace.
- Wasm
Alloc WebAssembly and allocandunsafe_layout - โฌก ๐งบ A WebAssembly global memory allocator that uses a bump allocation strategy.
- Wavelet
Haar wave - ใฐ๏ธ A Haar wavelet is a simple, piecewise-constant wavelet.
- Wavelet
Unit Vec allocandwave - ใฐ๏ธ A single unit of the wavelet decomposition at a specific level and position.
- Web
web - ๐ ๐ ๏ธ A Web API namespace.
- WebDocument
web - ๐ ๐ซ Handle to the browerโs global Document associated APIs.
- WebElement
web - ๐ ๐ซ Handle to a DOM Element.
- WebEvent
Key eventandweb - ๐ซ ๐ A web API keyboard event.
- WebEvent
Mouse eventandweb - ๐ซ ๐ A web API Mouse Event.
- WebEvent
Pointer eventandweb - ๐ซ ๐ A web API Pointer Event.
- WebEvent
Wheel eventandweb - ๐ซ ๐ A web API Wheel Event.
- WebWindow
web - โฆ ๐ Handle to the browserโs global Window and Screen associated APIs.
- WebWindow
State web - โฆ ๐
Aggregates the live state of a
WebWindow, including geometry and screen context. - WebWorker
web - ๐ ๐ซ A handle to a JavaScript Web Worker.
- WebWorker
Job web - ๐ ๐ซ
Represents a job running inside a
WebWorker. - Window
Id event - โฆ ๐ซ A backend-agnostic identifier for a UI window.
- Wrapping
- โ
coreProvides intentionally-wrapped arithmetic onT. - XCpu
Buffer unsafe_ffiandx11 - ๐ โฌก Cpu-backed pixel buffer for X11 image upload.
- XDisplay
unsafe_ffiandx11 - ๐ โฌก ๐ A connection to an X11 display server.
- XEvent
unsafe_ffiandx11 - ๐ ๐ซ Wrapper for an XCB event.
- XFrontend
unsafe_ffiandx11 - ๐ โฌก An X11 frontend for frame-driven runtimes.
- XPresent
unsafe_ffiandx11 - ๐ โฌก Borrowed byte-backed presentation artifact for X11.
- XRaster
Renderer unsafe_ffiandx11 - ๐ โฌก Projects a byte-backed X11 image scene into a borrowed presentation artifact.
- XShm
Buffer ffi_xcb_shmยทยทandunsafe_ffiandx11 - ๐ โฌก MIT-SHM-backed pixel buffer for X11 image upload.
- XSurface
Frame unsafe_ffiandx11 - ๐ โฌก Borrowed mutable X11 surface for direct frame rendering.
- XWindow
unsafe_ffiandx11 - ๐ ๐ซ ๐ X11 top-level drawable host and presentation target.
- Xabc
rand - ๐ฒ X ABC PRNG for 8-bit devices.
- XorShift8
rand - ๐ฒ
The
XorShift8PRNG. - XorShift16
rand - ๐ฒ
The
XorShift16PRNG. - XorShift32
rand - ๐ฒ
The
XorShift32PRNG. - XorShift64
rand - ๐ฒ
The
XorShift64PRNG. - XorShift128
rand - ๐ฒ
The
XorShift128PRNG. - XorShift128p
rand - ๐ฒ
The
XorShift128+PRNG. - Xoroshiro128pp
rand - ๐ฒ
The
Xoroshiro128++PRNG. - Xyza8a
rand - ๐ฒ A simple 8-bit PRNG with 32-bit of state, based on the XorShift algorithm.
- Xyza8b
rand - ๐ฒ A simple 8-bit PRNG with 32-bit of state, based on the XorShift algorithm.
- char7
- ๐ A 7-bit Unicode scalar, limited to basic latin subset (ASCII).
- char8
- ๐ An 8-bit Unicode scalar, limited to basic latin and latin-1 subsets.
- char16
- ๐ A 16-bit Unicode scalar, limited to the Basic Multilingual Plane subset.
- charu
- ๐ A 32-bit Unicode scalar, with UTF-8 representation.
- charu_
niche - ๐ A 32-bit Unicode scalar, with UTF-8 representation, and niche-memory optimization.
- f32bits
- โ
๐ก๏ธ
Bitwise wrapper for
f32providingEq,Ord, andHash. - f32bits_
niche - โ
โ๏ธ
Bitwise wrapper for
f32stored through a maskedNonMaxU32. - f64bits
- โ
๐ก๏ธ
Bitwise wrapper for
f64providingEq,Ord, andHash. - f64bits_
niche - โ
โ๏ธ
Bitwise wrapper for
f64stored through a maskedNonMaxU64. - g_bvec2
glsl - ๐
Equivalent to GLSL
bvec2, a vector of 2รg_bools. - g_bvec3
glsl - ๐
Equivalent to GLSL
bvec3, a vector of 3รg_bools. - g_bvec4
glsl - ๐
Equivalent to GLSL
bvec4, a vector of 4รg_bools. - g_dmat2
glsl - ๐
Equivalent to GLSL
dmat2, a column-major 2ร2 matrix ofg_doubles. - g_dmat3
glsl - ๐
Equivalent to GLSL
dmat3, a column-major 3ร3 matrix ofg_doubles. - g_dmat4
glsl - ๐
Equivalent to GLSL
dmat4, a column-major 4ร4 matrix ofg_doubles. - g_dvec2
glsl - ๐
Equivalent to GLSL
dvec2, a vector of 2รg_doubles. - g_dvec3
glsl - ๐
Equivalent to GLSL
dvec3, a vector of 3รg_doubles. - g_dvec4
glsl - ๐
Equivalent to GLSL
dvec4, a vector of 4รg_doubles. - g_ivec2
glsl - ๐
Equivalent to GLSL
ivec2, a vector of 2รg_ints. - g_ivec3
glsl - ๐
Equivalent to GLSL
ivec3, a vector of 3รg_ints. - g_ivec4
glsl - ๐
Equivalent to GLSL
ivec4, a vector of 4รg_ints. - g_mat2
glsl - ๐
Equivalent to GLSL
mat2, a column-major 2ร2 matrix ofg_floats. - g_mat3
glsl - ๐
Equivalent to GLSL
mat3x3, a column-major 3ร3 matrix ofg_floats. - g_mat4
glsl - ๐
Equivalent to GLSL
mat4x4, a column-major 4ร4 matrix ofg_floats. - g_
mat2x3 glsl - ๐
Equivalent to GLSL
mat2x3, a column-major 2ร3 matrix ofg_floats. - g_
mat2x4 glsl - ๐
Equivalent to GLSL
mat2x4, a column-major 2ร4 matrix ofg_floats. - g_
mat3x2 glsl - ๐
Equivalent to GLSL
mat3x2, a column-major 3ร2 matrix ofg_floats. - g_
mat3x4 glsl - ๐
Equivalent to GLSL
mat3x4, a column-major 3ร4 matrix ofg_floats. - g_
mat4x2 glsl - ๐
Equivalent to GLSL
mat4x2, a column-major 4ร2 matrix ofg_floats. - g_
mat4x3 glsl - ๐
Equivalent to GLSL
mat4x3, a column-major 4ร3 matrix ofg_floats. - g_uvec2
glsl - ๐
Equivalent to GLSL
ivec2, a vector of 2รg_uints. - g_uvec3
glsl - ๐
Equivalent to GLSL
ivec3, a vector of 3รg_uints. - g_uvec4
glsl - ๐
Equivalent to GLSL
ivec4, a vector of 4รg_uints. - g_vec2
glsl - ๐
Equivalent to GLSL
vec2, a vector of 2รg_floats. - g_vec3
glsl - ๐
Equivalent to GLSL
vec3, a vector of 3รg_floats. - g_vec4
glsl - ๐
Equivalent to GLSL
vec4, a vector of 4รg_floats. - g_
vertex2 glsl - ๐
A convenient 2D GLSL vertex representation with
g_floats (position + UV). - g_
vertex3 glsl - ๐
A convenient 3D GLSL vertex representation with
g_floats (position + UV). - m128
dep_safe_arch - ๐ฅ๏ธ
safe_archThe data for a 128-bit SSE register of fourf32lanes. - m256
dep_safe_arch - ๐ฅ๏ธ
safe_archThe data for a 256-bit AVX register of eightf32lanes. - m128d
dep_safe_arch - ๐ฅ๏ธ
safe_archThe data for a 128-bit SSE register of twof64values. - m128i
dep_safe_arch - ๐ฅ๏ธ
safe_archThe data for a 128-bit SSE register of integer data. - m256d
dep_safe_arch - ๐ฅ๏ธ
safe_archThe data for a 256-bit AVX register of fourf64values. - m256i
dep_safe_arch - ๐ฅ๏ธ
safe_archThe data for a 256-bit AVX register of integer data. - Iter
From Coroutine Experimental nightly_coro - ๐ โฌก
coreCreates an iterator where each iteration calls the provided coroutine. - Simd
Experimental - โ
coreA SIMD vector with the shape of[T; N]but the operations ofT.
Enumsยง
- Alsa
Error alsa - ๐ ๐ง ๐ฉ ALSA PCM error.
- Angle
Direction - ๐ The direction of rotation of an angle.
- Angle
Kind - ๐
The kind of
Angle, based on its normalized turn. - Ansi
Color term - ๐ฎ ๐จ Complete ANSI color selection
- Ansi
Color3 term - ๐ฎ ๐จ ANSI 3-bit color codes, 8 colors.
- AppControl
- โฌก ๐ซ External control notice directed at an application.
- Async
Poll - ๐งต โฌก
coreIndicates whether a value is ready or if the current task is still pending. - Atomic
Ordering - ๐งต โ๏ธ โค
coreAtomic memory ordering. - Audio
Channel audio - ๐ Individual spatial audio channel positions.
- Audio
Channels audio - ๐ Fixed, discrete multichannel audio layouts (1.0, 2.0, 5.1, 7.1, โฆ).
- Audio
Device Dir - ๐ ๐งญ Direction capability of an audio endpoint.
- Audio
Stream Dir - ๐ ๐งญ Direction of an audio stream.
- BTree
MapEntry alloc - ๐๏ธ โค
allocAn entry of an ordered map based on a B-Tree. - Backing
- ๐คท ๐ Controls how memory is provided for a value.
- Backtrace
Status std - ๐
stdThe current status of a backtrace. - Bound
- ๐
coreAn endpoint of a range of keys. - Boundary1d
- ๐ ๐งญ Orientation relative to a one-dimensional boundary.
- Boundary2d
- ๐ ๐งญ Orientation relative to a two-dimensional rectangular boundary.
- Boundary3d
- ๐ ๐งญ Orientation relative to a three-dimensional bounding volume.
- Call
Bind Time - โฆ When the callee identity becomes fixed.
- Call
Context - โฆ Where the callableโs execution environment resides.
- Call
Dispatch - โฆ Mechanism by which control transfers to the callee.
- Call
Openness - โฆ Whether the behavior set is fixed or extensible.
- Call
Storage - โฆ Where the callable representation resides.
- Char
Ascii - ๐
One of 128 Unicode characters (
U+0000toU+007F), the ASCII subset. - Color
Depth - ๐จ Color vocabulary depth.
- Compression
Mode - ๐ฅก The type of compression applied to data.
- Control
Flow - โ
coreUsed to tell an operation whether it should exit early or go on as usual. - Cow
alloc - ๐ซ ๐ ๐ฑ
allocA clone-on-write smart pointer. - Crypto
Error - ๐ ๐ฉ An error from a cryptographic codec or primitive.
- Data
NotEnough - ๐ฉ+
An error composite of
NotEnoughElements+NotEnoughSpace. - Diag
Level - ๐ชต The severity of a diagnostic emission.
- Encoding
Mode - ๐ฅก The primary mode for data encoding.
- Enum
Example docortest - โจ โ โ
An example enum generated with
enumset!. - Enumint
I8Example docortest - โจ โ
โ๏ธ
An example compact
i8enum from -126 to 126, generated withenumint!. - Event
Button event - ๐ซ ๐ฎ โ A normalized pressable pointer/mouse button.
- Event
Button State event - ๐ซ ๐ฎ Represents the state of a button.
- Event
Kind event - ๐ซ An enumeration of concrete event variants.
- Event
Pointer Kind event - ๐ซ ๐ฎ Enum representing the type of pointer.
- Event
Tag event - ๐ซ ๐ซ โ
A lightweight, data-less identifier for
EventKind. - Event
Target event - ๐ซ ๐ซ
Identifies what an
Eventis conceptually directed to. - Event
Timestamp Mode event - ๐ซ ๐
Selects how an
EventTimestampshould be formatted. - Event
Wheel Unit event - ๐ซ ๐ฎ
The semantic unit carried by an
EventWheel. - Event
Window event - ๐ซ ๐ฎ Events related to a window, viewport, or presentation surface.
- Float
Category - โ
coreA classification of floating point numbers. - FmtAlignment
- ๐น
corePossible alignments returned byFormatter::align. - FmtNum
Sign - ๐น โ Controls how the sign of a number is formatted.
- Grapheme
Boundary grapheme - ๐ Indicates how to handle a code point when detecting grapheme cluster boundaries.
- Grapheme
Kind grapheme - ๐ The kinds of supported graphemes.
- Grapheme
Prop Cb grapheme - ๐ EGC property values from Unicode Standard Annex #29.
- Grapheme
Prop InCb grapheme - ๐ Break property for Indic scripts that prevents splitting within orthographic syllables.
- Hash
MapEntry dep_hashbrownorstd - ๐๏ธ ๐
โกstdA view into a single entry in a map, which may either be vacant or occupied. - Http
Error http - ๐ก โ ๐ฉ HTTP parsing and formatting error.
- Http
Method http - ๐ก โ HTTP request method.
- Http
Status Class http - ๐ก โ The response class of an HTTP status code.
- Http
Version http - ๐ก โ HTTP protocol version.
- Image
Error - ๐ผ๏ธ ๐ฉ+ An image-related error.
- Infallible
- โ
๐ฉ
coreThe error type for errors that can never occur. - IntError
- ๐ฉ+ All possible integer operation errors.
- Invalid
Text - ๐ฉ+
๐
An error composite of
InvalidChar+InvalidUtf8+MismatchedCapacity. - IoError
Kind - ๐
๐ฉ+
?stdA list specifying general categories of I/O error. - IpAddr
- ๐ก
coreAn IP address, either IPv4 or IPv6. - JsValue
js - โฌก ๐ฑ A JavaScript value for FFI communication.
- Key
event - ๐ฎ
Keyboard codes, used in
EventKey. - KeyDead
event - ๐ฎ Dead-key accent operators used during text composition.
- KeyFfi
ffiยทยท - ๐ฎ ๐ก๏ธ
An FFI-safe version of
Key, used inEventKeyFfi. - KeyMedia
event - ๐ฎ Media key codes.
- KeyMod
event - ๐ฎ โ Modifier key codes (when pressed by themselves)
- KeyPad
event - ๐ฎ Keypad keys.
- KeyState
event - ๐ฎ
Represents the state of a
Key. - Linux
Clock linux - ๐ง ๐ ๐ซ
Linuxclock identifiers. - Linux
Error linux - ๐ง ๐ฉ+ Represents a Linux-related error.
- Linux
Random Mode linux - ๐ฒ ๐ง
Linux
getrandomrandomness mode. - Linux
Signal linux - ๐ง ๐ถ โ A linux signal
- Linux
Termios Char Size linux - ๐ง ๐ฎ A Linux termios character size.
- Maybe
Owned - ๐คท ๐ A container that may hold either a borrowed or owned value.
- MemHedge
Error - ๐ซ ๐งต ๐ฉ Errors produced by hedged control-state operations.
- MemHedge
State - ๐ซ ๐งต โ๏ธ Lifecycle state of a hedged read request.
- MemReplica
Error - ๐ฉ ๐ซ Errors produced by replicated layout construction and access.
- Mismatched
Bounds - ๐ฉ+
An error composite of
MismatchedCapacity+IndexOutOfBounds+MismatchedIndices - Month
time - ๐ The months of the year.
- Mpsc
Recv Timeout Error std - ๐งต ๐ฉ+
stdPossible errors that maderecv_timeoutunable to return data. - Mpsc
TryRecv Error std - ๐งต ๐ฉ+
stdPossible reasons thattry_recvcould not return data when called. - Mpsc
TrySend Error std - ๐งต ๐ฉ+
stdPossible error outcomes for thetry_sendmethod. - Niche
Value Error - ๐ฉ+ Invalid or problematic values for niche types.
- NotAvailable
- โ
๐ฉ+
An error composite of
NotImplemented+NotSupported. - NumError
- โ ๐ฉ+ A numeric-related error.
- Oneof
- โ A generic, parameterized enum for expressing structured alternatives.
- Option
- โ๏ธ
coreA type that represents an optional value. - Ordering
- โ
โค โ๏ธ
coreThe result of a comparison between two values. - Parse
IntError Kind - ๐ ::= โ
๐ฉ
coreKinds of errors that can cause parsing an integer to fail. - Partial
Space - ๐ฉ+
An error composite of
NotEnoughSpace+PartiallyAdded. - Path
Component std - ๐
stdA single component of a path. - Path
Windows Prefix std - ๐ ๐ช
stdWindows path prefixes, e.g.,C:or\\server\share. - PcmLayout
audio - ๐ ๐งฑ Sample arrangement of a PCM buffer.
- PcmRaw
Error audio - ๐ ๐ฉ Raw PCM encoding and decoding error.
- PcmSample
audio - ๐ Numeric encoding of a single PCM sample.
- PcmWav
Error audio - ๐ ๐ฉ WAVE encoding and decoding error.
- Repr
Mode - โ ๐ชช Selects how a value exposes one of its representations.
- Result
- โ๏ธ
coreA type that represents either success (Ok) or failure (Err). - Riff
Error - ๐ชช ๐ฅก ๐ฉ RIFF parsing error.
- RunControl
- โฌก Control returned by a runtime step.
- RunDriver
Error - โฌก ๐ฉ Errors returned while driving a runtime step.
- RunDriver
Frame Error - โฌก ๐ฉ Errors returned while driving a runtime frame step.
- RunPhase
- โฌก High-level phases of a running system.
- Shell
Word Error shell - ๐ ๐ฉ+ An error while parsing or quoting shell words.
- Sign
- ๐ The three-valued sign of a number: negative (โ1), zero (0), or positive (+1).
- Socket
Addr - ๐ก ๐ซ
coreAn internet socket address, either IPv4 or IPv6. - Sparse
SetError - ๐๏ธ ๐ฉ โ Sparse-set operation error.
- Static
MapEntry - ๐๏ธ Represents an entry in a static map allowing for in-place mutation or insertion.
- TcpShutdown
std - ๐ก
stdPossible values which can be passed to theTcpStream::shutdownmethod. - TermCap
term - ๐ฎ โฌก โ Terminal capability flag.
- Term
Color Kind term - ๐ฎ ๐จ The stored representation of a terminal color.
- Term
Color Mode term - ๐ฎ ๐จ The composition mode of one terminal color.
- Term
Grid Error term - ๐ฎ ๐๏ธ ๐ฉ Terminal grid construction, access, and rendering error.
- Term
Line Mode term - ๐ฎ ๐ฎ How terminal input is delivered to an application.
- Term
Poll Policy term - ๐ฎ ๐ซ Terminal event polling policy.
- Termel
Occupancy term - ๐ฎ ๐ ๐งฑ โซ๏ธ The cell-space occupancy represented by terminal-element metadata.
- Text
Cohesion - ๐ ๐งฑ Spatial cohesion rules for a text symbol during layout.
- Text
Error - ๐ ๐ฉ+ A text-related composite error.
- TextFit
- ๐ ๐งฑ โ๏ธ Result of testing whether text fits within an inline extent.
- Text
Parse Error Kind - ๐ ::= ๐ฉ The category of a text parsing failure.
- Time
Error std - ๐ฉ+ ๐ A time-related composite error.
- Time
Scale - ๐ Describes the conceptual scale at which time is expressed or interpreted.
- TryLock
Error std - ๐งต ๐ฉ+
stdAn enumeration of possible errors associated with aTryLockResult. - Tuple
Element _tuple - โ cgen
An element of a
Tuple. - Tuple
Element Mut _tuple - โ ๐ cgen
An exclusive reference to an element of a
Tuple. - Tuple
Element Ref _tuple - โ ๐ cgen
A shared reference to an element of a
Tuple. - UiError
uiยทยท - โฆ ๐ฉ+ A user-interface error.
- UnitBi
unit - โ Binary unit prefixes.
- UnitSi
unit - โ SI (metric) unit prefixes.
- Value
Kind - ๐ชช ๐ฑ The semantic category of a value word.
- Value
Kind4 - ๐ชช ๐ฑ A 4-bit compact value category.
- VarError
std - ๐ฉ ๐ฅ๏ธ
stdReturned fromEnv::var. - VecChunk
alloc - ๐๏ธ A persistent data structure with efficient append and concatenation operations.
- Wavelet
Unit Role wave - ใฐ๏ธ Distinguishes the role of a component in wavelet analysis.
- WebEvent
Kind eventandweb - ๐ซ ๐ ๐ซ A typed selector for web event names used by the web API browser bridge.
- WebKey
Location eventandweb - ๐ฎ ๐ Which part of the keyboard the key event originates from.
- WebPermission
web - ๐ Web API permissions
- WebPermission
State web - ๐ โ๏ธ Permission query result state.
- WebWorker
Error web - ๐ ๐ฉ Errors that can occur when working with JavaScript Web Workers.
- Weekday
time - ๐ The days of the week.
- XError
unsafe_ffiandx11 - ๐ ๐ฉ XCB/X11 error categories.
- XImage
Mode unsafe_ffiandx11 - ๐ โฌก Presentation backing policy for X11 image upload.
- c_void
- โ๏ธ
coreEquivalent to Cโs void type when used as a pointer. - Coroutine
State Experimental nightly_coro - ๐งต โฌก โ๏ธ
coreThe result of a coroutine resumption.
Constantsยง
- FONT_
ART_ 4_ 3 font - ๐ ต A simple 4x3 Unicode-art font.
- FONT_
BIT_ 3_ 3 font - ๐ ต A simple 3x3 bitmap font.
- FONT_
BIT_ 3_ 5 font - ๐ ต A simple 3x5 bitmap font.
- FONT_
BIT_ 5_ 6 font - ๐ ต A simple 5x6 bitmap font.
- UNIX_
EPOCH std - ๐
stdASystemTimeanchored to โ1970-01-01 00:00:00 UTCโ.
Staticsยง
- __
LOGGER_ sixel_ encoder_ 64_ 64 __dbg - ๐ ๐ชต ๐ผ๏ธ ๐ฎ
Static debug logger for
SixelEncoder.
Traitsยง
- Add
- โ
coreThe addition operator+. - AddAssign
- โ
coreThe addition assignment operator+=. - Any
- โ
coreA trait to emulate dynamic typing. - AnyExt
- โ
Extension trait providing convenience methods for
T:Any. - AppEnv
std - ๐ฅ๏ธ Manages directory paths in an environment-aware manner.
- Array
Ext - ๐๏ธ
Extension trait providing convenience methods for
[T; N]arrays. - AsFd
std - ๐
stdA trait to borrow the file descriptor from an underlying object. - AsFdRaw
std - ๐ ๐ซ
stdA trait to extract the raw file descriptor from an underlying object. - AsMut
- ๐
coreUsed to do a cheap mutable-to-mutable reference conversion. - AsRef
- ๐
coreUsed to do a cheap reference-to-reference conversion. - Async
Wake alloc - ๐งต โ๏ธ โฌก
?allocThe implementation of waking a task on an executor. - Binary
- ๐น โ
corebformatting. - BitAnd
- โง
coreThe bitwise AND operator&. - BitAnd
Assign - โง
coreThe bitwise AND assignment operator&=. - BitOps
- โ
๐ ๏ธ
Provides bitwise operations on
T. - BitOr
- โง
coreThe bitwise OR operator|. - BitOr
Assign - โง
coreThe bitwise OR assignment operator|=. - BitSized
- ๐ซ Type size information in bits.
- BitXor
- โง
coreThe bitwise XOR operator^. - BitXor
Assign - โง
coreThe bitwise XOR assignment operator^=. - Borrow
- ๐
coreA trait for borrowing data. - Borrow
Mut - ๐
coreA trait for mutably borrowing data. - Byte
Sized - ๐ซ Type size information in bytes.
- Canvas
draw - ๐ผ๏ธ A writable 2D drawing surface over abstract spatial units.
- Canvas
Read draw - ๐ผ๏ธ Read access to colors from a canvas-like surface.
- Canvas
Textel draw - ๐ผ๏ธ ๐
A
Canvasthat can place text render elements. - Cell
Option Ext - ๐ซ
Extension trait providing additional methods for
Cell<Option>. - Clone
- ๐ฑ
coreA common trait that allows explicit creation of a duplicate value. (Derivable) - Color
- ๐จ Base trait for general color data representation.
- Const
Bool - โ โง Allows to convert compile-time constants into type-level booleans.
- Const
Init - ๐ฑ A trait for giving a type a useful const-friendly initial value.
- Copy
- โ
coreTypes whose values can be duplicated simply by copying bits. (Derivable) - Data
Array - ๐๏ธ An abstract array data type.
- Data
Collection - ๐๏ธ An abstract collection data type.
- Data
Deque - ๐๏ธ An abstract double-ended queue data type.
- Data
Desta - ๐๏ธ An abstract double-ended stack data type.
- Data
Queue - ๐๏ธ An abstract queue data type.
- Data
Stack - ๐๏ธ An abstract stack data type.
- Debug
- ๐น ๐
core?formatting. (Derivable) - Debug
Ext - ๐น ๐ Extension for contextual debugging.
- Default
- ๐ฑ
coreA trait for giving a type a useful default value. (Derivable) - Deref
- ๐
coreUsed for immutable dereferencing operations, like*v. - Deref
Mut - ๐
coreUsed for mutable dereferencing operations, like in*v = 1;. - DiagOut
- ๐ชต Emits leveled diagnostic text.
- Display
- ๐น
coreFormat trait for an empty format,{}. - Div
- โ
coreThe division operator/. - DivAssign
- โ
coreThe division assignment operator/=. - Drop
- ๐
coreCustom code within the destructor. - DstBuf
unsafe_layout - ๐๏ธ Represents the backing buffer for storing dynamically sized types.
- Eq
- โ
coreTrait for comparisons corresponding to equivalence relations. (Derivable) - Error
- โ ๐ฉ
coreA trait representing the basic expectations for error values. - Float
Const - โ ๐ ๏ธ Extension trait for floating-point types. Associated constants.
- Float
Ext - โ ๐ ๏ธ Extension trait for floating-point types. Associated methods.
- FmtWrite
- ๐น
coreWriting or formatting into Unicode-accepting buffers or streams. - Fn
- โ
coreThe version of the call operator that takes an immutable receiver. - FnMut
- โ
coreThe version of the call operator that takes a mutable receiver. - FnOnce
- โ
coreThe version of the call operator that takes a by-value receiver. - From
- ๐ฑ
coreUsed to do value-to-value conversions while consuming the input value. - From
FdRaw std - ๐ ๐ซ ๐ฑ
stdExpresses the ability to construct an object from a raw file descriptor. - From
Rand - ๐ฒ ๐๏ธ Infallible construction from a source of randomness.
- From
Rand Try - ๐ฒ ๐๏ธ Fallible construction from a source of randomness.
- FromStr
- ๐ ๐
coreParse a value from a string. - Future
- ๐งต โฌก
coreAn asynchronous computation obtained by use ofasync. - Future
Ext - ๐งต โฌก
Extension trait providing additional methods for
Futures. - Global
Alloc alloc - ๐งบ
allocA memory allocator that can be registered as the standard libraryโs default. - Grapheme
grapheme - ๐ Common trait for EGC types.
- Hash
- ๐
coreA trait for creating instances ofHasher. (Derivable) - Hasher
- ๐
coreA trait for hashing an arbitrary stream of bytes. - Hasher
Build - ๐
coreA trait for creating instances ofHasher. - Hook
- โ ๐ฑ Hooks operations into a value without breaking its flow.
- Index
- ๐ฑ ๐
coreUsed for indexing operations (container[index]) in immutable contexts. - Index
Mut - ๐ฑ ๐
coreUsed for indexing operations (container[index]) in mutable contexts. - Index
Repr - โ ๐ซ โ โ๏ธ โ๏ธ A representation accepted for compact contiguous indexing.
- Into
- ๐ฑ
coreA value-to-value conversion that consumes the input value. - Into
FdRaw std - ๐ ๐ซ ๐ฑ
stdExpresses the ability to consume an object and own its raw file descriptor. - Into
Future - ๐ฑ ๐งต โฌก
coreConversion into aFuture. - Introspect
- ๐ Introspection core trait.
- IoBuf
Read - ๐
?stdA type ofReader which has an internal buffer. - IoDuplex
- ๐ A duplex byte I/O primitive.
- IoRead
- ๐
?stdAllows for reading bytes from a source. - IoSeek
- ๐
?stdProvides a cursor which can be moved within a stream of bytes. - IoWrite
- ๐
?stdA trait for objects which are byte-oriented sinks. - Iterator
- ๐
coreA trait for dealing with iterators. - Iterator
Double Ended - ๐
coreAn iterator able to yield elements from both ends. - Iterator
Exact Size - ๐
coreAn iterator that knows its exact length. - Iterator
Extend - ๐
coreExtend a collection with the contents of an iterator. - Iterator
From - ๐
coreConversion from anIterator. - Iterator
Fused - ๐
coreAn iterator that always continues to yieldNonewhen exhausted. - Iterator
Into - ๐
coreConversion into anIterator. - Iterator
Lending - ๐ ๐ A lending iterator using a generic associated lifetime.
- Iterator
Lending Double Ended - ๐ ๐ A lending iterator that can yield items from the back.
- Iterator
Lending Exact Size - ๐ ๐ A lending iterator with a known remaining length.
- Iterator
Lending Peek - ๐ ๐ A lending iterator that can inspect the next item without advancing.
- Iterator
Lending Peek Double Ended - ๐ ๐ A lending iterator that can inspect the next item from the back, without advancing.
- Iterator
Product - ๐ โ
coreRepresents types that can be created by multiplying elements of an iterator. - Iterator
Sum - ๐ โ
coreRepresents types that can be created by summing up an iterator. - Lower
Exp - ๐น โ
coreeformatting. - Lower
Hex - ๐น โ
corexformatting. - MemAligned
- ๐ซ Marker trait to verify memory alignment between two types.
- MemExt
- ๐ ๏ธ Extension trait for type memory information and manipulation.
- MemPod
unsafe_layout - ๐ซ Indicates a type is Plain Old Data, and meets specific memory layout guarantees.
- Morph
- โ ๐ฑ Morphs a value by threading it through a function.
- Mul
- โ
coreThe multiplication operator*. - MulAssign
- โ
coreThe multiplication assignment operator*=. - Neg
- โ
coreThe unary negation operator-. - Not
- โง
coreThe unary logical negation operator!. - Num
num - โ Common trait for numeric types.
- NumConst
- โ Fundamental numeric constants for both integer and floating-point types.
- NumInt
int - โ Common trait for integer types.
- NumRef
num - โ ๐ Common auto-trait for referenced numeric types.
- NumRef
Int int - โ ๐ Common auto-trait for referenced integer types.
- NumVector
lin - ๐ง โ A common trait for all vectors.
- Octal
- ๐น โ
coreoformatting. - OptRes
Ext - โ๏ธ
Extension trait providing additional methods for
OptRes. - Option
Ext - โ๏ธ
Extension trait providing additional methods for
Option. - Ord
- โ
โค
coreTrait for types that form a total order. (Derivable) - Output
Ext std - ๐ฅ๏ธ ๐งต ๐ ๏ธ
Extension trait providing convenience methods interpreting process
Output. - Ownership
- ๐ Defines the relationship between a borrowed type and its owned counterpart.
- Panic
RefUnwind Safe - โ ๐
coreA marker trait which represents a shared reference considered unwind safe. - Panic
Unwind Safe - โ
coreA marker trait which represents โpanic safeโ types in Rust. - Partial
Eq - โ
coreTrait for comparisons using the equality operator. (Derivable) - Partial
Ord - โ
โค
coreTrait for types that form a partial order. (Derivable) - PathExt
std - ๐
Extension trait providing additional methods for
PathandPathBuf. - PcmDrain
audio - A PCM stream that can wait for pending playback frames to finish.
- PcmSample
Type audio - ๐ Rust sample type with a fixed PCM sample encoding.
- PcmSink
audio - ๐ A stream that writes interleaved PCM frames.
- PcmSink
Planar audio - ๐ A stream that writes planar PCM frames.
- PcmSource
audio - ๐ A stream that reads interleaved PCM frames.
- PcmSource
Planar audio - ๐ A stream that reads planar PCM frames.
- PcmStream
audio - ๐ A configured PCM stream.
- Pointer
- ๐น
corepformatting. - Prim
- โ โ๏ธ Language primitive value types.
- Prim
Cast - โ โ๏ธ Offers methods for casting between primitives.
- Prim
FitPtr - โ ๐ซ โ๏ธ Primitive value types that fit in pointer-width on supported Rust targets.
- Prim
Float - โ โ โ๏ธ Primitive floating-point numbers.
- Prim
Index - โ ๐ซ โ โ๏ธ Primitive types that can be used for indexing.
- PrimInt
- โ โ โ๏ธ Primitive integer numbers.
- Prim
Join - โ โ๏ธ Offers methods to construct a primitive from an array or slice of smaller primitives.
- Prim
Scalar - โ โ โ๏ธ Primitive scalars, both integers and floating-point numbers.
- Prim
Sint - โ โ โ๏ธ Signed primitive integer numbers.
- Prim
Split - โ โ๏ธ Offers methods to split a primitive into an array of smaller primitives.
- Prim
Uint - โ โ โ๏ธ Unsigned primitive integer numbers.
- Process
Ext std - ๐ฅ๏ธ ๐งต ๐ ๏ธ
Extension trait providing additional methods for
Processes. - Process
Termination std - ๐ฅ๏ธ โฌก
stdA trait for implementing arbitrary return types in themainfunction. - Rand
- ๐ฒ Infallible source of raw random data.
- Rand
Seedable - ๐ฒ Construction from explicit seed material or another random source.
- RandTry
- ๐ฒ Fallible source of raw random data.
- Range
Bounds - ๐
coreImplemented by Rustโs built-in range types - Raster
- ๐ผ๏ธ A retained dense raster that owns its sample storage.
- Raster
Buf - ๐ผ๏ธ Exclusive access to a dense 2D raster over contiguous samples.
- Raster
BufBytes - ๐ผ๏ธ Exclusive access to a dense 2D byte raster with explicit row layout.
- Raster
Sample Packed - ๐ผ๏ธ Marker for packed sample types supported by safe byte reinterpretation.
- Raster
View - ๐ผ๏ธ A borrowed dense 2D raster view over contiguous samples.
- Raster
View Bytes - ๐ผ๏ธ A borrowed dense 2D byte raster view with explicit row layout.
- Raster
View Packed - ๐ผ๏ธ A typed raster view whose packed samples can be exposed as bytes.
- Rem
- โ
coreThe remainder operator%. - RemAssign
- โ
coreThe remainder assignment operator%=. - Result
Ext - โ๏ธ
Extension trait providing additional methods for
Result. - RunApp
- โฌก App logic driven step-by-step by a runtime.
- RunBackend
- โฌก Minimal backend contract for runtime-driven frontends.
- RunPresent
- โฌก Presentation finalization driven by a runtime.
- RunRender
- โฌก Rendering logic driven by a runtime frame.
- RunService
- โฌก Reports runtime service metadata.
- RunService
Probe - โฌก Actively refreshes runtime service capabilities.
- Send
- โ ๐งต
coreTypes that can be transferred across thread boundaries. - Sized
- โ
coreTypes with a constant size known at compile time. - Slice
Ext - ๐ ๏ธ
Extension trait providing additional methods for
&[T]. - Slice
ExtMut - ๐ ๏ธ
Extension trait providing additional methods for
&mut [T]. - Storage
- ๐ซ Allows data structures to be generic over their storage strategy.
- StrExt
- ๐งถ
Extension trait providing additional methods for
&str. - String
Ext alloc - ๐งถ
Extension trait providing additional methods for
String. - Sub
- โ
coreThe subtraction operator-. - SubAssign
- โ
coreThe subtraction assignment operator-=. - Sync
- โ ๐งต
coreTypes for which it is safe to share references between threads. - TextIn
- ๐ ๐ Reads UTF-8 text from an input surface into caller-provided storage.
- TextOut
- ๐ ๐ Emits UTF-8 text to an output surface.
- Thread
Ext std - ๐งต ๐ ๏ธ
Extension trait providing additional methods for
Threads. - Time
Point - ๐ A comparable representation of a point on a time-like timeline.
- Time
Source - ๐ A source of time points with a canonical numeric projection.
- Time
Source Cfg - ๐ A configurable source of time points with a canonical numeric projection.
- Time
Span - ๐ A comparable span on a time-like timeline.
- ToOwned
alloc - ๐ซ ๐ฑ
allocA generalization of Clone to borrowed data. - ToSocket
Addrs std - ๐ก
stdObjects which can be converted or resolved to one or moreSocketAddrvalues. - ToString
alloc - ๐ ๐ฑ
allocA trait for converting a value to aString. - TryFrom
- ๐ฑ
coreSimple and safe type conversions that may fail in a controlled way. - TryInto
- ๐ฑ
coreAn attempted conversion that consumes self, which may be expensive. - Tuple
_tuple - โ ๐๏ธ cgen Extension trait providing convenience methods for tuples.
- Type
Resourced - โ ๐ซ Represents an association between a resource and its inner data type.
- Unicode
Scalar - ๐ Common trait for Unicode scalar types.
- Unit
unit - โ Common trait for unit prefixes.
- Unpin
- โ
coreTypes that do not require any pinning guarantees. - Upper
Exp - ๐น โ
coreEformatting. - Upper
Hex - ๐น โ
coreXformatting. - VecExt
alloc - ๐๏ธ
Extension trait providing additional methods for
Vec. - Wavelet
Compression Vec allocandwave - ใฐ๏ธ Trait for lossy compression of wavelet coefficients.
- Wavelet
Transform Vec allocandwave - ใฐ๏ธ Trait defining essential wavelet transform operations.
- Word
- ๐ชช โฃ A fixed-width copyable item with an explicit raw representation.
- Coroutine
Experimental nightly_coro - ๐งต โฌก
coreThe trait implemented by builtin coroutine types. - Simd
Const Ptr Experimental - โ
๐
coreOperations on SIMD vectors of constant pointers. - Simd
Float Experimental - โ
coreOperations on SIMD vectors of floats. - SimdInt
Experimental - โ
coreOperations on SIMD vectors of signed integers. - Simd
MutPtr Experimental - โ
๐
coreOperations on SIMD vectors of mutable pointers. - SimdOrd
Experimental - โ
โค
coreParallelOrd. - Simd
Partial Eq Experimental - โ
coreParallelPartialEq. - Simd
Partial Ord Experimental - โ
โค
coreParallel PartialOrd. - Simd
Uint Experimental - โ
coreOperations on SIMD vectors of unsigned integers.
Functionsยง
- __
logger_ โsixel_ encoder_ 64_ 64 __dbg - ๐ ๐ชต ๐ผ๏ธ ๐ฎ
Static debug logger for
SixelEncoder. Returns a mutable reference to the global static__LOGGER_sixel_encoder_64_64. - ansi_
print linuxorstd - ๐ฎ ๐ฅ๏ธ
A function to print an ANSI escape
sequenceof bytes tostdout - ansi_
print_ linux linux - ๐ฎ ๐ง
The most efficient print method, exclusive for
linux. - ansi_
print_ std std - ๐ฎ ๐ฅ๏ธ
The most efficient print method, exclusive for
std. - any_
type_ name - โ
coreReturns the name of a type as a string slice. - array_
from_ fn - ๐๏ธ
coreCreates an array[T; N], where eachTis returned fromcbfrom its index. - array_
from_ mut - ๐๏ธ
coreConverts a mutable reference toTinto&mut [T; 1](without copying). - array_
from_ ref - ๐๏ธ
coreConverts a reference toTinto&[T; 1](without copying). - assert_
unchecked โ - ๐ฏ
coreMakes a soundness promise to the compiler that thecondition holds. - atomic_
compiler_ fence - ๐งต โ๏ธ
coreA compiler memory fence. - atomic_
fence - ๐งต โ๏ธ
coreAn atomic fence. - black_
box - โ
coreHints the compiler to be maximally pessimistic about what black_box could do. - cold_
path - โ
coreHints to the compiler that given path is cold, i.e., unlikely to be taken. - fn_
addr_ eq - ๐ซ
coreCompares the addresses of the two function pointers for equality. - identity
- โ
coreThe identity function. Just returns back its input. - is_
leap_ year time - ๐
Returns
trueif the providedyearis a leap year. - likely
- โ
Indicate that a given
conditionis likely to be true. - prime_
number_ theorem - โ The prime number theorem formula.
- select_
unpredictable - โ
coreHints the compiler that theconditionis branch-unpredictable. - serr
- โ๏ธ
Wraps the given
OptResvaluein aSome(Err(error)). - sok
- โ๏ธ
Wraps the given
OptResvaluein aSome(Ok(value)). - spin_
loop - โ
coreSignals the processor that it is running in a busy-wait spin-loop. - transmuteโ
Deprecated - ๐ซ
coreReinterprets the bits of a value of one type as another type. - unlikely
- โ
Indicate that a given
conditionis likely to be false. - unreachable_
unchecked โ - ๐ฏ
coreInforms the compiler that the current calling site is not reachable.
Type Aliasesยง
- Bare
- โ
๐ซ
coreA zero-sized marker for aStoragetype that wraps its data in aBareBox. - Base16
- ๐ฅก
Base16standard encoding (hex), with linear search. Case-insensitive. - Base32
- ๐ฅก
Base32standard encoding, using LUT decoding. Case-sensitive. - Base64
- ๐ฅก
Base64standard encoding, using LUT decoding. Case-sensitive. - Base32
Crockford - ๐ฅก
Base32Crockfordencoding. Case-insensitive, remapsO โ 0,I/L โ 1. - Base32
Hex - ๐ฅก
Base32Hexuses RFC 4648 hex-encoding (0-9 A-Vinstead ofA-Z 2-7). - Base32
Padded - ๐ฅก
Base32encoding with padding (=) enabled, using LUT decoding. - Base64
Padded - ๐ฅก
Base64encoding with padding (=) enabled, using LUT decoding. - Destaque
U8 _destaque_u8 - ๐๏ธ
A
Destaquewith an 8-bit index size. - Distance1
- ๐
A 1-dimensional
Distance. - Distance2
- ๐
A 2-dimensional
Distance. - Distance3
- ๐
A 3-dimensional
Distance. - 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 allocandunsafe_layout - ๐๏ธ A dynamically allocated buffer for storing DSTs with pointer alignment.
- Event
Kind Timed event - ๐ซ ๐ ๐คท A convenience helper for optionally timed event kinds.
- Extent1
- ๐
A 1-dimensional
Extent. - Extent2
- ๐
A 2-dimensional
Extent. - Extent3
- ๐
A 3-dimensional
Extent. - FdRaw
- ๐ ๐ซ Raw file descriptors.
- FmtResult
- ๐น โ๏ธ The type returned by formatter methods.
- Hash
MapFx hashand (std, ordep_hashbrownandhash) - ๐๏ธ ๐
A
HashMapusing a default Fx hasher. - Hash
MapStd std - ๐๏ธ ๐
The
HashMapin the standard library. - Hash
SetFx hashand (std, ordep_hashbrownandhash) - ๐๏ธ ๐ โ
A
HashSetusing a default Fx hasher. - Hash
SetStd std - ๐๏ธ ๐ โ
The
HashSetin the standard library. - Hasher
Build Fnv hash - ๐ ๐ฑ A builder for default Fnv hashers.
- Hasher
Build Fx - ๐ ๐ฑ A builder for default Fx hashers.
- Image
Result - ๐ผ๏ธ โ๏ธ An image-related result.
- Infallible
Result - โ๏ธ โ ๐ฉ A result type whose error case can never occur.
- IntResult
- โ โ๏ธ A result of a fallible integer operation.
- IoResult
- ๐
โ๏ธ
?stdA specializedResulttype for I/O operations. - LINUX_
SYS linux - ๐ง ๐ฅ๏ธLinux
sys/syscall.hconstants for the current compilation target. - Lightness
color - ๐จ Perceptual lightness (L*).
- Linear
Lightness color - ๐จ Linearized perceptual lightness (L* in linear space).
- Linux
Result linux - ๐ง โ๏ธ The return type for Linux-related functions that can fail.
- Lock
Result std - ๐งต โ๏ธ
stdA type alias for the result of a lock method which can be poisoned. - Luma
color - ๐จ Gamma-encoded luma (Yโฒ).
- Luminance
color - ๐จ Physical luminance.
- Maybe
Byte - ๐คท ๐ซ A byte type that may be uninitialized depending on features.
- Maybe
Timed - ๐ ๐คท A value paired with an optional time-like companion.
- NoData
- โ ๐ชช Represents the absence of some data.
- NoNum
- โ โ Represents the absence of a number.
- NoTime
- โ ๐ Represents the absence of time.
- NonMax
U8 - โ
โ๏ธ
An unsigned integer that is known not to equal its
MAXvalue. - NonMax
U16 - โ
โ๏ธ
An unsigned integer that is known not to equal its
MAXvalue. - NonMax
U32 - โ
โ๏ธ
An unsigned integer that is known not to equal its
MAXvalue. - NonMax
U64 - โ
โ๏ธ
An unsigned integer that is known not to equal its
MAXvalue. - NonMax
U128 - โ
โ๏ธ
An unsigned integer that is known not to equal its
MAXvalue. - NonMax
Usize - โ
โ๏ธ
An unsigned integer that is known not to equal its
MAXvalue. - NonMin
I8 - โ
โ๏ธ
A signed integer that is known not to equal its
MINvalue. - NonMin
I16 - โ
โ๏ธ
A signed integer that is known not to equal its
MINvalue. - NonMin
I32 - โ
โ๏ธ
A signed integer that is known not to equal its
MINvalue. - NonMin
I64 - โ
โ๏ธ
A signed integer that is known not to equal its
MINvalue. - NonMin
I128 - โ
โ๏ธ
A signed integer that is known not to equal its
MINvalue. - NonMin
Isize - โ
โ๏ธ
A signed integer that is known not to equal its
MINvalue. - NonZero
I8 - โ
โ๏ธ
coreA signed integer that is known not to equal zero. - NonZero
I16 - โ
โ๏ธ
coreA signed integer that is known not to equal zero. - NonZero
I32 - โ
โ๏ธ
coreA signed integer that is known not to equal zero. - NonZero
I64 - โ
โ๏ธ
coreA signed integer that is known not to equal zero. - NonZero
I128 - โ
โ๏ธ
coreA signed integer that is known not to equal zero. - NonZero
Isize - โ
โ๏ธ
coreA signed integer that is known not to equal zero. - NonZero
U8 - โ
โ๏ธ
coreAn unsigned integer that is known not to equal zero. - NonZero
U16 - โ
โ๏ธ
coreAn unsigned integer that is known not to equal zero. - NonZero
U32 - โ
โ๏ธ
coreAn unsigned integer that is known not to equal zero. - NonZero
U64 - โ
โ๏ธ
coreAn unsigned integer that is known not to equal zero. - NonZero
U128 - โ
โ๏ธ
coreAn unsigned integer that is known not to equal zero. - NonZero
Usize - โ
โ๏ธ
coreAn unsigned integer that is known not to equal zero. - NumResult
- โ โ๏ธ A numeric-related result.
- OptRes
- โ๏ธ An optional result type that combines success, failure, and absence.
- Orientation1
- ๐ ๐งญ
A 1-dimensional
Orientation. - Orientation2
- ๐ ๐งญ
A 2-dimensional
Orientation. - Orientation3
- ๐ ๐งญ
A 3-dimensional
Orientation. - Point2d
- ๐ A specific position in 2d-space without a size.
- Point3d
- ๐ A specific position in 3d-space without a size.
- Points2d
- ๐
A static sequence of 2-dimensional
Points. - Position1
- ๐
A 1-dimensional
Position. - Position2
- ๐
A 2-dimensional
Position. - Position3
- ๐
A 3-dimensional
Position. - Region1
- ๐
A 1-dimensional
Region. - Region2
- ๐
A 2-dimensional
Region. - Region3
- ๐
A 3-dimensional
Region. - RegionS
- ๐
A
PositionedExtentsharing the Same type. - Region
S1 - ๐
A 1-dimensional
RegionS. - Region
S2 - ๐
A 2-dimensional
RegionS. - Region
S3 - ๐
A 3-dimensional
RegionS. - Rgb8
color - ๐จ RGB color with 8-bit integer channels (sRGB gamma space).
- Rgb16
color - ๐จ RGB color with 16-bit integer channels (sRGB gamma space).
- RgbF32
color - ๐จ RGB color with 32-bit float channels (sRGB gamma space).
- RgbF64
color - ๐จ RGB color with 64-bit float channels (sRGB gamma space).
- RgbLin
F32 color - ๐จ RGB color with 32-bit float channels (linear space).
- RgbLin
F64 color - ๐จ RGB color with 64-bit float channels (linear space).
- Rgba8
color - ๐จ RGB+A color with 8-bit integer channels (sRGB gamma space, straight alpha).
- Rgba16
color - ๐จ RGB+A color with 16-bit integer channels (sRGB gamma space, straight alpha).
- RgbaF32
color - ๐จ RGB+A color with 32-bit float channels (sRGB gamma space, straight alpha).
- RgbaF64
color - ๐จ RGB+A color with 64-bit float channels (sRGB gamma space, straight alpha).
- Rgba
LinF32 color - ๐จ RGB+A color with 32-bit float channels (linear space, straight alpha).
- Rgba
LinF64 color - ๐จ RGB+A color with 64-bit float channels (linear space, straight alpha).
- Rgba
LinPre F32 color - ๐จ RGB+A color with 32-bit float channels (linear space, premultiplied alpha).
- Rgba
LinPre F64 color - ๐จ RGB+A color with 64-bit float channels (linear space, premultiplied alpha).
- Rgba
Pre8 color - ๐จ RGB+A color with 8-bit integer channels (sRGB gamma space, premultiplied alpha).
- Rgba
Pre16 color - ๐จ RGB+A color with 16-bit integer channels (sRGB gamma space, premultiplied alpha).
- Rgba
PreF32 color - ๐จ RGB+A color with 32-bit float channels (sRGB gamma space, premultiplied alpha).
- Rgba
PreF64 color - ๐จ RGB+A color with 64-bit float channels (sRGB gamma space, premultiplied alpha).
- StackU8
_stack_u8 - ๐๏ธ
A
Stackwith an 8-bit index size. - Stride1
- ๐
A 1-dimensional
Stride. - Stride2
- ๐
A 2-dimensional
Stride. - Stride3
- ๐
A 3-dimensional
Stride. - Text
Result - ๐ โ๏ธ A text-related result.
- Text
Unit - ๐ Basic text-domain unit.
- Thread
Result std - ๐งต โ๏ธ
stdA specializedResulttype for threads. - Time
Split Hour Nano - ๐ A time split from hours to nanoseconds.
- Time
Split Hour Nano Norm - ๐ A time split from hours to nanoseconds, normalized (128b payload).
- Time
Split Hour Sec - ๐ A time split from hours to seconds.
- Time
Split Hour SecNorm - ๐ A time split from hours to seconds, normalized (80b payload).
- Time
Split Milli Nano - ๐ A time split from milliseconds to nanoseconds.
- Time
Split Milli Nano Norm - ๐ A time split from milliseconds to nanoseconds, normalized (48b payload).
- Time
Split Norm - ๐ A time split from years to nanoseconds, normalized (152b payload).
- Time
Split Year Day - ๐ A time split from years to days.
- Time
Split Year DayNorm - ๐ A time split from years to days, normalized (80b payload).
- Time
Split Year Sec - ๐ A time split from years to seconds.
- Time
Split Year SecNorm - ๐ A time split from years to seconds, normalized (104b payload).
- TryLock
Result std - ๐งต โ๏ธ
stdA type alias for the result of a nonblocking locking method. - UiResult
uiยทยท - โฆ โ๏ธ A user-interface result.
- Vector2d
lin - โ A static 2-dimensional vector.
- Vector3d
lin - โ A static 3-dimensional vector.
- c_bool
- โ๏ธ โง
Equivalent to C99
_Bool/<stdbool.h>bool. - c_char
- โ๏ธ ๐
coreEquivalent to the corresponding C type. - c_
double - โ๏ธ โ
coreEquivalent to the corresponding C type. - c_float
- โ๏ธ โ
coreEquivalent to the corresponding C type. - c_int
- โ๏ธ โ
coreEquivalent to the corresponding C type. - c_long
- โ๏ธ โ
coreEquivalent to the corresponding C type. - c_
longlong - โ๏ธ โ
coreEquivalent to the corresponding C type. - c_
mode_ t - โ๏ธ โ
Equivalent to Cโs
mode_ttype. - c_off_t
- โ๏ธ โ
Equivalent to Cโs
off_ttype. - c_schar
- โ๏ธ ๐
coreEquivalent to the corresponding C type. - c_short
- โ๏ธ โ
coreEquivalent to the corresponding C type. - c_
size_ t - โ๏ธ โ
Equivalent to Cโs
size_ttype. - c_
ssize_ t - โ๏ธ โ
Equivalent to Cโs
ssize_ttype. - c_uchar
- โ๏ธ ๐
coreEquivalent to the corresponding C type. - c_uint
- โ๏ธ โ
coreEquivalent to the corresponding C type. - c_ulong
- โ๏ธ โ
coreEquivalent to the corresponding C type. - c_
ulonglong - โ๏ธ โ
coreEquivalent to the corresponding C type. - c_
ushort - โ๏ธ โ
coreEquivalent to the corresponding C type. - char
- โ๏ธ ๐
coreA 32-bit Unicode scalar. - fsize
16-bit or 32-bit or 64-bit - โ๏ธ โ A pointer-sized floating-point primitive.
- g_bool
glsl - โ๏ธ โง A GLSL boolean.
- g_
double glsl - โ๏ธ โ A GLSL double-precision floating-point number.
- g_float
glsl - โ๏ธ โ A GLSL single-precision floating-point number.
- g_int
glsl - โ๏ธ โ A GLSL signed 32-bit integer.
- g_uint
glsl - โ๏ธ โ A GLSL unsigned 32-bit integer.
- isize_
down 16-bit or 32-bit or 64-bit - โ๏ธ โ A downcasted pointer-sized signed integer primitive.
- isize_
up 16-bit or 32-bit or 64-bit - โ๏ธ โ An upcasted pointer-sized signed integer primitive.
- js_bool
js - โ๏ธ โง
A JavaScript boolean (
true/false). - js_
int32 js - โ๏ธ โ A JavaScript signed 32-bit integer.
- js_null
js - โ๏ธ โ
The JavaScript
nullvalue. - js_
number js - โ๏ธ โ A JavaScript Number.
- js_str
js - โ๏ธ ๐ A JavaScript string reference.
- js_
uint32 js - โ๏ธ โ A JavaScript unsigned 32-bit integer.
- js_
undefined js - โ๏ธ โ
The JavaScript
undefinedvalue. - usize_
down 16-bit or 32-bit or 64-bit - โ๏ธ โ A downcasted pointer-sized unsigned integer primitive.
- usize_
up 16-bit or 32-bit or 64-bit - โ๏ธ โ An upcasted pointer-sized unsigned integer primitive.
Unionsยง
- Maybe
Uninit - ๐คท ๐ซ
coreA wrapper type to construct uninitialized instances ofT.
Attribute Macrosยง
- compile
- โ proc Conditionally compiles the thing it is attached to based on the predicate.
- compile_
attr - โ proc Conditionally compiles the given attributes based on the predicate.
- macro_
apply - โ proc Applies a declarative macro to the decorated item.
- macro_
derive - โ proc Runs classic derives and declarative derives from one list.
- macro_
derive_ with - โ proc Runs declarative derive-like macros over the decorated item.
Derive Macrosยง
- Clone
- ๐ฑ
coreA common trait that allows explicit creation of a duplicate value. (Derivable) - Copy
- โ
coreTypes whose values can be duplicated simply by copying bits. (Derivable) - Debug
- ๐น ๐
core?formatting. (Derivable) - Default
- ๐ฑ
coreA trait for giving a type a useful default value. (Derivable) - Eq
- โ
coreTrait for comparisons corresponding to equivalence relations. (Derivable) - Hash
- ๐
coreA trait for creating instances ofHasher. (Derivable) - Ord
- โ
โค
coreTrait for types that form a total order. (Derivable) - Partial
Eq - โ
coreTrait for comparisons using the equality operator. (Derivable) - Partial
Ord - โ
โค
coreTrait for types that form a partial order. (Derivable)