mirror of
https://github.com/rust-lang/rust.git
synced 2026-05-22 18:15:07 +03:00
Alex Crichton
6a585375a0
As with the previous commit with `librand`, this commit shuffles around some
`collections` code. The new state of the world is similar to that of librand:
* The libcollections crate now only depends on libcore and liballoc.
* The standard library has a new module, `std::collections`. All functionality
of libcollections is reexported through this module.
I would like to stress that this change is purely cosmetic. There are very few
alterations to these primitives.
There are a number of notable points about the new organization:
* std::{str, slice, string, vec} all moved to libcollections. There is no reason
that these primitives shouldn't be necessarily usable in a freestanding
context that has allocation. These are all reexported in their usual places in
the standard library.
* The `hashmap`, and transitively the `lru_cache`, modules no longer reside in
`libcollections`, but rather in libstd. The reason for this is because the
`HashMap::new` contructor requires access to the OSRng for initially seeding
the hash map. Beyond this requirement, there is no reason that the hashmap
could not move to libcollections.
I do, however, have a plan to move the hash map to the collections module. The
`HashMap::new` function could be altered to require that the `H` hasher
parameter ascribe to the `Default` trait, allowing the entire `hashmap` module
to live in libcollections. The key idea would be that the default hasher would
be different in libstd. Something along the lines of:
// src/libstd/collections/mod.rs
pub type HashMap<K, V, H = RandomizedSipHasher> =
core_collections::HashMap<K, V, H>;
This is not possible today because you cannot invoke static methods through
type aliases. If we modified the compiler, however, to allow invocation of
static methods through type aliases, then this type definition would
essentially be switching the default hasher from `SipHasher` in libcollections
to a libstd-defined `RandomizedSipHasher` type. This type's `Default`
implementation would randomly seed the `SipHasher` instance, and otherwise
perform the same as `SipHasher`.
This future state doesn't seem incredibly far off, but until that time comes,
the hashmap module will live in libstd to not compromise on functionality.
* In preparation for the hashmap moving to libcollections, the `hash` module has
moved from libstd to libcollections. A previously snapshotted commit enables a
distinct `Writer` trait to live in the `hash` module which `Hash`
implementations are now parameterized over.
Due to using a custom trait, the `SipHasher` implementation has lost its
specialized methods for writing integers. These can be re-added
backwards-compatibly in the future via default methods if necessary, but the
FNV hashing should satisfy much of the need for speedier hashing.
A list of breaking changes:
* HashMap::{get, get_mut} no longer fails with the key formatted into the error
message with `{:?}`, instead, a generic message is printed. With backtraces,
it should still be not-too-hard to track down errors.
* The HashMap, HashSet, and LruCache types are now available through
std::collections instead of the collections crate.
* Manual implementations of hash should be parameterized over `hash::Writer`
instead of just `Writer`.
[breaking-change]
284 lines
8.9 KiB
Rust
284 lines
8.9 KiB
Rust
// Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
|
|
// file at the top-level directory of this distribution and at
|
|
// http://rust-lang.org/COPYRIGHT.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
|
|
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
|
|
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
|
|
// option. This file may not be copied, modified, or distributed
|
|
// except according to those terms.
|
|
|
|
//! # The Rust Standard Library
|
|
//!
|
|
//! The Rust Standard Library provides the essential runtime
|
|
//! functionality for building portable Rust software.
|
|
//! It is linked to all Rust crates by default.
|
|
//!
|
|
//! ## Intrinsic types and operations
|
|
//!
|
|
//! The [`ptr`](ptr/index.html) and [`mem`](mem/index.html)
|
|
//! modules deal with unsafe pointers and memory manipulation.
|
|
//! [`kinds`](kinds/index.html) defines the special built-in traits,
|
|
//! and [`raw`](raw/index.html) the runtime representation of Rust types.
|
|
//! These are some of the lowest-level building blocks in Rust.
|
|
//!
|
|
//! ## Math on primitive types and math traits
|
|
//!
|
|
//! Although basic operations on primitive types are implemented
|
|
//! directly by the compiler, the standard library additionally
|
|
//! defines many common operations through traits defined in
|
|
//! mod [`num`](num/index.html).
|
|
//!
|
|
//! ## Pervasive types
|
|
//!
|
|
//! The [`option`](option/index.html) and [`result`](result/index.html)
|
|
//! modules define optional and error-handling types, `Option` and `Result`.
|
|
//! [`iter`](iter/index.html) defines Rust's iterator protocol
|
|
//! along with a wide variety of iterators.
|
|
//! [`Cell` and `RefCell`](cell/index.html) are for creating types that
|
|
//! manage their own mutability.
|
|
//!
|
|
//! ## Vectors, slices and strings
|
|
//!
|
|
//! The common container type, `Vec`, a growable vector backed by an
|
|
//! array, lives in the [`vec`](vec/index.html) module. References to
|
|
//! arrays, `&[T]`, more commonly called "slices", are built-in types
|
|
//! for which the [`slice`](slice/index.html) module defines many
|
|
//! methods.
|
|
//!
|
|
//! `&str`, a UTF-8 string, is a built-in type, and the standard library
|
|
//! defines methods for it on a variety of traits in the
|
|
//! [`str`](str/index.html) module. Rust strings are immutable;
|
|
//! use the `String` type defined in [`string`](string/index.html)
|
|
//! for a mutable string builder.
|
|
//!
|
|
//! For converting to strings use the [`format!`](fmt/index.html)
|
|
//! macro, and for converting from strings use the
|
|
//! [`FromStr`](from_str/index.html) trait.
|
|
//!
|
|
//! ## Platform abstractions
|
|
//!
|
|
//! Besides basic data types, the standard library is largely concerned
|
|
//! with abstracting over differences in common platforms, most notably
|
|
//! Windows and Unix derivatives. The [`os`](os/index.html) module
|
|
//! provides a number of basic functions for interacting with the
|
|
//! operating environment, including program arguments, environment
|
|
//! variables, and directory navigation. The [`path`](path/index.html)
|
|
//! module encapsulates the platform-specific rules for dealing
|
|
//! with file paths.
|
|
//!
|
|
//! `std` also includes modules for interoperating with the
|
|
//! C language: [`c_str`](c_str/index.html) and
|
|
//! [`c_vec`](c_vec/index.html).
|
|
//!
|
|
//! ## Concurrency, I/O, and the runtime
|
|
//!
|
|
//! The [`task`](task/index.html) module contains Rust's threading abstractions,
|
|
//! while [`comm`](comm/index.html) contains the channel types for message
|
|
//! passing. [`sync`](sync/index.html) contains further, primitive, shared
|
|
//! memory types, including [`atomics`](sync/atomics/index.html).
|
|
//!
|
|
//! Common types of I/O, including files, TCP, UPD, pipes, Unix domain sockets,
|
|
//! timers, and process spawning, are defined in the [`io`](io/index.html) module.
|
|
//!
|
|
//! Rust's I/O and concurrency depends on a small runtime interface
|
|
//! that lives, along with its support code, in mod [`rt`](rt/index.html).
|
|
//! While a notable part of the standard library's architecture, this
|
|
//! module is not intended for public use.
|
|
//!
|
|
//! ## The Rust prelude and macros
|
|
//!
|
|
//! Finally, the [`prelude`](prelude/index.html) defines a
|
|
//! common set of traits, types, and functions that are made available
|
|
//! to all code by default. [`macros`](macros/index.html) contains
|
|
//! all the standard macros, such as `assert!`, `fail!`, `println!`,
|
|
//! and `format!`, also available to all Rust code.
|
|
|
|
#![crate_id = "std#0.11.0-pre"]
|
|
#![comment = "The Rust standard library"]
|
|
#![license = "MIT/ASL2"]
|
|
#![crate_type = "rlib"]
|
|
#![crate_type = "dylib"]
|
|
#![doc(html_logo_url = "http://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
|
|
html_favicon_url = "http://www.rust-lang.org/favicon.ico",
|
|
html_root_url = "http://doc.rust-lang.org/")]
|
|
#![feature(macro_rules, globs, asm, managed_boxes, thread_local, link_args,
|
|
linkage, default_type_params, phase, concat_idents, quad_precision_float)]
|
|
|
|
// Don't link to std. We are std.
|
|
#![no_std]
|
|
|
|
#![allow(deprecated)]
|
|
#![deny(missing_doc)]
|
|
|
|
// When testing libstd, bring in libuv as the I/O backend so tests can print
|
|
// things and all of the std::io tests have an I/O interface to run on top
|
|
// of
|
|
#[cfg(test)] extern crate rustuv;
|
|
#[cfg(test)] extern crate native;
|
|
#[cfg(test)] extern crate green;
|
|
#[cfg(test)] extern crate debug;
|
|
#[cfg(test)] #[phase(syntax, link)] extern crate log;
|
|
|
|
extern crate alloc;
|
|
extern crate core;
|
|
extern crate libc;
|
|
extern crate core_rand = "rand";
|
|
extern crate core_collections = "collections";
|
|
|
|
// Make std testable by not duplicating lang items. See #2912
|
|
#[cfg(test)] extern crate realstd = "std";
|
|
#[cfg(test)] pub use realstd::kinds;
|
|
#[cfg(test)] pub use realstd::ops;
|
|
#[cfg(test)] pub use realstd::cmp;
|
|
#[cfg(test)] pub use realstd::ty;
|
|
|
|
|
|
// NB: These reexports are in the order they should be listed in rustdoc
|
|
|
|
pub use core::any;
|
|
pub use core::bool;
|
|
pub use core::cell;
|
|
pub use core::char;
|
|
pub use core::clone;
|
|
#[cfg(not(test))] pub use core::cmp;
|
|
pub use core::container;
|
|
pub use core::default;
|
|
pub use core::finally;
|
|
pub use core::intrinsics;
|
|
pub use core::iter;
|
|
#[cfg(not(test))] pub use core::kinds;
|
|
pub use core::mem;
|
|
#[cfg(not(test))] pub use core::ops;
|
|
pub use core::ptr;
|
|
pub use core::raw;
|
|
pub use core::simd;
|
|
pub use core::tuple;
|
|
#[cfg(not(test))] pub use core::ty;
|
|
pub use core::result;
|
|
pub use core::option;
|
|
|
|
pub use alloc::owned;
|
|
pub use alloc::rc;
|
|
|
|
pub use core_collections::hash;
|
|
pub use core_collections::slice;
|
|
pub use core_collections::str;
|
|
pub use core_collections::string;
|
|
pub use core_collections::vec;
|
|
|
|
// Run tests with libgreen instead of libnative.
|
|
//
|
|
// FIXME: This egregiously hacks around starting the test runner in a different
|
|
// threading mode than the default by reaching into the auto-generated
|
|
// '__test' module.
|
|
#[cfg(test)] #[start]
|
|
fn start(argc: int, argv: **u8) -> int {
|
|
green::start(argc, argv, rustuv::event_loop, __test::main)
|
|
}
|
|
|
|
/* Exported macros */
|
|
|
|
pub mod macros;
|
|
pub mod bitflags;
|
|
|
|
mod rtdeps;
|
|
|
|
/* The Prelude. */
|
|
|
|
pub mod prelude;
|
|
|
|
|
|
/* Primitive types */
|
|
|
|
#[path = "num/float_macros.rs"] mod float_macros;
|
|
#[path = "num/int_macros.rs"] mod int_macros;
|
|
#[path = "num/uint_macros.rs"] mod uint_macros;
|
|
|
|
#[path = "num/int.rs"] pub mod int;
|
|
#[path = "num/i8.rs"] pub mod i8;
|
|
#[path = "num/i16.rs"] pub mod i16;
|
|
#[path = "num/i32.rs"] pub mod i32;
|
|
#[path = "num/i64.rs"] pub mod i64;
|
|
|
|
#[path = "num/uint.rs"] pub mod uint;
|
|
#[path = "num/u8.rs"] pub mod u8;
|
|
#[path = "num/u16.rs"] pub mod u16;
|
|
#[path = "num/u32.rs"] pub mod u32;
|
|
#[path = "num/u64.rs"] pub mod u64;
|
|
|
|
#[path = "num/f32.rs"] pub mod f32;
|
|
#[path = "num/f64.rs"] pub mod f64;
|
|
|
|
pub mod rand;
|
|
|
|
pub mod ascii;
|
|
|
|
pub mod gc;
|
|
|
|
/* Common traits */
|
|
|
|
pub mod from_str;
|
|
pub mod num;
|
|
pub mod to_str;
|
|
|
|
/* Common data structures */
|
|
|
|
pub mod collections;
|
|
|
|
/* Tasks and communication */
|
|
|
|
pub mod task;
|
|
pub mod comm;
|
|
pub mod local_data;
|
|
pub mod sync;
|
|
|
|
|
|
/* Runtime and platform support */
|
|
|
|
pub mod c_str;
|
|
pub mod c_vec;
|
|
pub mod os;
|
|
pub mod io;
|
|
pub mod path;
|
|
pub mod fmt;
|
|
pub mod cleanup;
|
|
|
|
// Private APIs
|
|
#[unstable]
|
|
pub mod unstable;
|
|
|
|
// FIXME #7809: This shouldn't be pub, and it should be reexported under 'unstable'
|
|
// but name resolution doesn't work without it being pub.
|
|
#[unstable]
|
|
pub mod rt;
|
|
|
|
#[doc(hidden)]
|
|
pub fn issue_14344_workaround() { // FIXME #14344 force linkage to happen correctly
|
|
libc::issue_14344_workaround();
|
|
}
|
|
|
|
// A curious inner-module that's not exported that contains the binding
|
|
// 'std' so that macro-expanded references to std::error and such
|
|
// can be resolved within libstd.
|
|
#[doc(hidden)]
|
|
mod std {
|
|
// mods used for deriving
|
|
pub use clone;
|
|
pub use cmp;
|
|
pub use hash;
|
|
|
|
pub use comm; // used for select!()
|
|
pub use fmt; // used for any formatting strings
|
|
pub use io; // used for println!()
|
|
pub use local_data; // used for local_data_key!()
|
|
pub use option; // used for bitflags!()
|
|
pub use rt; // used for fail!()
|
|
pub use vec; // used for vec![]
|
|
|
|
// The test runner calls ::std::os::args() but really wants realstd
|
|
#[cfg(test)] pub use os = realstd::os;
|
|
// The test runner requires std::slice::Vector, so re-export std::slice just for it.
|
|
#[cfg(test)] pub use slice;
|
|
}
|