summaryrefslogtreecommitdiffstats
path: root/vendor/smallvec/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/smallvec/README.md')
-rw-r--r--vendor/smallvec/README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/vendor/smallvec/README.md b/vendor/smallvec/README.md
new file mode 100644
index 000000000..724637c6e
--- /dev/null
+++ b/vendor/smallvec/README.md
@@ -0,0 +1,26 @@
+rust-smallvec
+=============
+
+[Documentation](https://docs.rs/smallvec/)
+
+[Release notes](https://github.com/servo/rust-smallvec/releases)
+
+"Small vector" optimization for Rust: store up to a small number of items on the stack
+
+## Example
+
+```rust
+use smallvec::{SmallVec, smallvec};
+
+// This SmallVec can hold up to 4 items on the stack:
+let mut v: SmallVec<[i32; 4]> = smallvec![1, 2, 3, 4];
+
+// It will automatically move its contents to the heap if
+// contains more than four items:
+v.push(5);
+
+// SmallVec points to a slice, so you can use normal slice
+// indexing and other methods to access its contents:
+v[0] = v[1] + v[2];
+v.sort();
+```