Skip to content

Commit 19048d5

Browse files
committed
Add a simple example to the README
1 parent 941d6aa commit 19048d5

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,21 @@ rust-smallvec
66
[Release notes](https://github.com/servo/rust-smallvec/releases)
77

88
"Small vector" optimization for Rust: store up to a small number of items on the stack
9+
10+
## Example
11+
12+
```rust
13+
use smallvec::{SmallVec, smallvec};
14+
15+
// This SmallVec can hold up to 4 items on the stack:
16+
let mut v: SmallVec<[i32; 4]> = smallvec![1, 2, 3, 4];
17+
18+
// It will automatically move its contents to the heap if
19+
// contains more than four items:
20+
v.push(5);
21+
22+
// SmallVec points to a slice, so you can use normal slice
23+
// indexing and other methods to access its contents:
24+
v[0] = v[1] + v[2];
25+
v.sort();
26+
```

0 commit comments

Comments
 (0)