Browse Source

Add the use_collections feature.

whitequark 8 years ago
parent
commit
7e7c0d1248
2 changed files with 10 additions and 4 deletions
  1. 1 0
      Cargo.toml
  2. 9 4
      README.md

+ 1 - 0
Cargo.toml

@@ -23,5 +23,6 @@ getopts = "0.2"
 [features]
 use_std = ["managed/use_std", "libc"]
 use_alloc = ["managed/use_alloc"]
+use_collections = ["managed/use_collections"]
 use_log = ["log"]
 default = ["use_std", "use_log"]

+ 9 - 4
README.md

@@ -82,15 +82,20 @@ smoltcp = { version = ..., default-features = false, features = [...] }
 
 ### Feature `use_std`
 
-The `use_std` feature enables use of buffers owned by the networking stack through a dependency
-on `std::boxed::Box`. It also enables `smoltcp::phy::RawSocket` and `smoltcp::phy::TapInterface`,
-if the platform supports it.
+The `use_std` feature enables use of objects and slices owned by the networking stack through a
+dependency on `std::boxed::Box` and `std::vec::Vec`. It also enables `smoltcp::phy::RawSocket`
+and `smoltcp::phy::TapInterface`, if the platform supports it.
 
 ### Feature `use_alloc`
 
-The `use_std` feature enables use of buffers owned by the networking stack through a dependency
+The `use_std` feature enables use of objects owned by the networking stack through a dependency
 on `alloc::boxed::Box`. This only works on nightly rustc.
 
+### Feature `use_collections`
+
+The `use_std` feature enables use of slices owned by the networking stack through a dependency
+on `collections::vec::Vec`. This only works on nightly rustc.
+
 ### Feature `use_log`
 
 The `use_log` feature enables logging of events within the networking stack through