Crate coreUnstable

The Rust Core Library

The Rust Core Library is the dependency-free foundation of The Rust Standard Library. It is the portable glue between the language and its libraries, defining the intrinsic and primitive building blocks of all Rust code. It links to no upstream libraries, no system libraries, and no libc.

The core library is minimal: it isn't even aware of heap allocation, nor does it provide concurrency or I/O. These things require platform integration, and this library is platform-agnostic.

It is not recommended to use the core library. The stable functionality of libcore is reexported from the standard library. The composition of this library is subject to change over time; only the interface exposed through libstd is intended to be stable.

How to use the core library

This library is built on the assumption of a few existing symbols:

• memcpy, memcmp, memset - These are core memory routines which are often generated by LLVM. Additionally, this library can make explicit calls to these functions. Their signatures are the same as found in C. These functions are often provided by the system libc, but can also be provided by librlibc which is distributed with the standard rust distribution.

• rust_begin_unwind - This function takes three arguments, a fmt::Arguments, a &str, and a uint. These three arguments dictate the panic message, the file at which panic was invoked, and the line. It is up to consumers of this core library to define this panic function; it is only required to never return.

Primitive Types

bool
char	Character manipulation.
f32	Operations and constants for 32-bits floats (f32 type)
f64	Operations and constants for 64-bits floats (f64 type)
i16	Operations and constants for signed 16-bits integers (i16 type)
i32	Operations and constants for signed 32-bits integers (i32 type)
i64	Operations and constants for signed 64-bits integers (i64 type)
i8	Operations and constants for signed 8-bits integers (i8 type)
isize	Operations and constants for pointer-sized signed integers (isize type)
slice	Slice management and manipulation
str	String manipulation
tuple	Operations on tuples
u16	Operations and constants for unsigned 16-bits integers (u16 type)
u32	Operations and constants for unsigned 32-bits integers (u32 type)
u64	Operations and constants for unsigned 64-bits integer (u64 type)
u8	Operations and constants for unsigned 8-bits integers (u8 type)
usize	Operations and constants for pointer-sized unsigned integers (usize type)

Modules

any	Traits for dynamic typing of any 'static type (through runtime reflection)
atomic	Atomic types
cell	Shareable mutable containers.
char	Character manipulation.
clone	The Clone trait for types that cannot be 'implicitly copied'
cmp	Functionality for ordering and comparison.
default	The Default trait for types which may have meaningful default values.
error	Traits for working with Errors.
f32	Operations and constants for 32-bits floats (f32 type)
f64	Operations and constants for 64-bits floats (f64 type)
finally	The Finally trait provides a method, finally on stack closures that emulates Java-style try/finally blocks.
fmt	Utilities for formatting and printing strings
hash	Generic hashing support.
i16	Operations and constants for signed 16-bits integers (i16 type)
i32	Operations and constants for signed 32-bits integers (i32 type)
i64	Operations and constants for signed 64-bits integers (i64 type)
i8	Operations and constants for signed 8-bits integers (i8 type)
int	Deprecated: replaced by isize.
intrinsics	rustc compiler intrinsics.
isize	Operations and constants for pointer-sized signed integers (isize type)
iter	Composable external iterators
marker	Primitive traits and marker types representing basic 'kinds' of types.
mem	Basic functions for dealing with memory
nonzero	Exposes the NonZero lang item which provides optimization hints.
num	Numeric traits and functions for the built-in numeric types.
ops	Overloadable operators
option	Optional values
panicking	Panic support for libcore
prelude	The core prelude
ptr	Operations on unsafe pointers, *const T, and *mut T.
raw	Contains struct definitions for the layout of compiler built-in types.
result	Error handling with the Result type
simd	SIMD vectors.
slice	Slice management and manipulation
str	String manipulation
u16	Operations and constants for unsigned 16-bits integers (u16 type)
u32	Operations and constants for unsigned 32-bits integers (u32 type)
u64	Operations and constants for unsigned 64-bits integer (u64 type)
u8	Operations and constants for unsigned 8-bits integers (u8 type)
uint	Deprecated: replaced by usize.
usize	Operations and constants for pointer-sized unsigned integers (usize type)

Macros

assert!	Ensure that a boolean expression is true at runtime.
assert_eq!	Asserts that two expressions are equal to each other, testing equality in both directions.
debug_assert!	Ensure that a boolean expression is true at runtime.
debug_assert_eq!	Asserts that two expressions are equal to each other, testing equality in both directions.
panic!	Entry point of task panic, for details, see std::macros
try!	Short circuiting evaluation on Err
unimplemented!	A standardised placeholder for marking unfinished code. It panics with the message "not yet implemented" when executed.
unreachable!	A utility macro for indicating unreachable code.
write!	Use the format! syntax to write data into a buffer of type &mut Writer. See std::fmt for more information.
writeln!	Equivalent to the write! macro, except that a newline is appended after the message is written.