Skip to content

Adding an initial description to vec.rs. #7223

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 47 additions & 1 deletion src/libstd/vec.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,53 @@
// option. This file may not be copied, modified, or distributed
// except according to those terms.

//! Vectors
/*!

The `vec` module contains useful code to help work with vector values. Vectors are Rust's list
type. Vectors contain zero or more values of homogeneous types:

~~~ {.rust}
let int_vector = [1,2,3];
let str_vector = ["one", "two", "three"];
~~~

This is a big module, but for a high-level overview:

## Structs

Several structs that are useful for vectors, such as `VecIterator`, which
represents iteration over a vector.

## Traits

A number of traits that allow you to accomplish tasks with vectors, like the
`MutableVector` and `ImmutableVector` traits.

## Implementations of other traits

Vectors are a very useful type, and so there's tons of implementations of
traits found elsewhere. Some notable examples:

* `Clone`
* `Iterator`
* `Zero`

## Function definitions

There are a number of different functions that take vectors, here are some
broad categories:

* Modifying a vector, like `append` and `grow`.
* Searching in a vector, like `bsearch`.
* Iterating over vectors, like `each_permutation`.
* Functional transformations on vectors, like `map` and `partition`.
* Stack/queue operations, like `push`/`pop` and `shift`/`unshift`.
* Cons-y operations, like `head` and `tail`.
* Zipper operations, like `zip` and `unzip`.

And much, much more.

*/

#[warn(non_camel_case_types)];

Expand Down