Expand description
nostd provides essential std-like types in no_std environments.
This crate re-exports types from the alloc and core crates under the
familiar std path while also offering alternative implementations for
types not available in those crates.
nostd aims to help port code written for std to no_std with minimal
changes, often requiring only a replacement of std:: with nostd::.
⚠️ Warning: A successful build does not guarantee that the code will work as expected. Exercise caution and thoroughly test your application before using it in production.
§Features
std::preludeemulation
use nostd::prelude::*;
// Now you can access `Box`, `String`, `Vec`, etc.std::ioemulation bycore2(feature:io)std::collections::hash_(map|set)emulation byhashbrown(feature:hashbrown)
§Usage
Add this to your Cargo.toml:
[dependencies]
nostd = "0.1"By default, nostd is intended to be used in no_std environment. To use
it in std environment, enable the std feature:
[features]
default = ["std"]
std = ["nostd/std"]Modules§
- alloc
- any
- Utilities for dynamic typing or type reflection.
- arch
- SIMD and vendor intrinsics module.
- array
- Utilities for the array primitive type.
- ascii
- Operations on ASCII strings and characters.
- borrow
- boxed
- The
Box<T>type for heap allocation. - bstr
- cell
- Shareable mutable containers.
- char
- Utilities for the
charprimitive type. - clone
- The
Clonetrait for types that cannot be ‘implicitly copied’. - cmp
- Utilities for comparing and ordering values.
- collections
- convert
- Traits for conversions between types.
- default
- The
Defaulttrait for types with a default value. - error
- Interfaces for working with Errors.
- f32
- Constants for the
f32single-precision floating point type. - f64
- Constants for the
f64double-precision floating point type. - ffi
- fmt
- future
- Asynchronous basic functionality.
- hash
- Generic hashing support.
- hint
- Hints to compiler that affects how code should be emitted or optimized.
- i8
Deprecation planned - Redundant constants module for the
i8primitive type. - i16
Deprecation planned - Redundant constants module for the
i16primitive type. - i32
Deprecation planned - Redundant constants module for the
i32primitive type. - i64
Deprecation planned - Redundant constants module for the
i64primitive type. - i128
Deprecation planned - Redundant constants module for the
i128primitive type. - io
- Traits, helpers, and type definitions for core I/O functionality.
- isize
Deprecation planned - Redundant constants module for the
isizeprimitive type. - iter
- Composable external iteration.
- marker
- Primitive traits and types representing basic properties of types.
- mem
- Basic functions for dealing with memory.
- net
- Networking primitives for IP communication.
- num
- Numeric traits and functions for the built-in numeric types.
- ops
- Overloadable operators.
- option
- Optional values.
- panic
- Panic support in the standard library.
- pin
- Types that pin data to a location in memory.
- prelude
- The nostd prelude
- primitive
- This module reexports the primitive types to allow usage that is not possibly shadowed by other declared types.
- ptr
- Manually manage memory through raw pointers.
- rc
- Single-threaded reference-counting pointers. ‘Rc’ stands for ‘Reference Counted’.
- result
- Error handling with the
Resulttype. - slice
- str
- string
- A UTF-8–encoded, growable string.
- sync
- task
- time
- Temporal quantification.
- u8
Deprecation planned - Redundant constants module for the
u8primitive type. - u16
Deprecation planned - Redundant constants module for the
u16primitive type. - u32
Deprecation planned - Redundant constants module for the
u32primitive type. - u64
Deprecation planned - Redundant constants module for the
u64primitive type. - u128
Deprecation planned - Redundant constants module for the
u128primitive type. - usize
Deprecation planned - Redundant constants module for the
usizeprimitive type. - vec
- A contiguous growable array type with heap-allocated contents, written
Vec<T>. - wtf8
- assert_
matches Experimental - Unstable module containing the unstable
assert_matchesmacro. - async_
iter Experimental - Composable asynchronous iteration.
- autodiff
Experimental - Unstable module containing the unstable
autodiffmacro. - contracts
Experimental - Unstable module containing the unstable contracts lang items and attribute macros.
- f16
Experimental - Constants for the
f16half-precision floating point type. - f128
Experimental - Constants for the
f128quadruple-precision floating point type. - from
Experimental - Unstable module containing the unstable
Fromderive macro. - index
Experimental - Helper types for indexing slices.
- intrinsics
Experimental - Compiler intrinsics.
- os
Experimental - OS-specific functionality.
- panicking
Experimental - Panic support for core
- pat
Experimental - Helper module for exporting the
pattern_typemacro - profiling
Experimental - Profiling markers for compiler instrumentation.
- random
Experimental - Random value generation.
- range
Experimental - Experimental replacement range types
- simd
Experimental - Portable SIMD module.
- ub_
checks Experimental - Provides the
assert_unsafe_preconditionmacro as well as some utility functions that cover common preconditions. - unsafe_
binder Experimental - Operators used to turn types into unsafe binders and back.
Macros§
- assert
- Asserts that a boolean expression is
trueat runtime. - assert_
eq - Asserts that two expressions are equal to each other (using
PartialEq). - assert_
ne - Asserts that two expressions are not equal to each other (using
PartialEq). - cfg
- Evaluates boolean combinations of configuration flags at compile-time.
- column
- Expands to the column number at which it was invoked.
- compile_
error - Causes compilation to fail with the given error message when encountered.
- concat
- Concatenates literals into a static string slice.
- debug_
assert - Asserts that a boolean expression is
trueat runtime. - debug_
assert_ eq - Asserts that two expressions are equal to each other.
- debug_
assert_ ne - Asserts that two expressions are not equal to each other.
- env
- Inspects an environment variable at compile time.
- export
- file
- Expands to the file name in which it was invoked.
- format
- Creates a
Stringusing interpolation of runtime expressions. - format_
args - Constructs parameters for the other string-formatting macros.
- import
- include
- Parses a file as an expression or an item according to the context.
- include_
bytes - Includes a file as a reference to a byte array.
- include_
str - Includes a UTF-8 encoded file as a string.
- line
- Expands to the line number on which it was invoked.
- matches
- Returns whether the given expression matches the provided pattern.
- module_
path - Expands to a string that represents the current module path.
- option_
env - Optionally inspects an environment variable at compile time.
- panic
- Panics the current thread.
- stringify
- Stringifies its arguments.
- todo
- Indicates unfinished code.
- try
Deprecated - Unwraps a result or propagates its error.
- unimplemented
- Indicates unimplemented code by panicking with a message of “not implemented”.
- unreachable
- Indicates unreachable code.
- vec
- Creates a
Veccontaining the arguments. - write
- Writes formatted data into a buffer.
- writeln
- Writes formatted data into a buffer, with a newline appended.
- assert_
unsafe_ precondition Experimental - Checks that the preconditions of an unsafe function are followed.
- cfg_
select Experimental - Selects code at compile-time based on
cfgpredicates. - concat_
bytes Experimental - Concatenates literals into a byte slice.
- const_
format_ args Experimental - Same as
format_args, but can be used in some const contexts. - log_
syntax Experimental - Prints passed tokens into the standard output.
- pattern_
type Experimental - Creates a pattern type.
- trace_
macros Experimental - Enables or disables tracing functionality used for debugging other macros.