Skip to content

Commit a46baf3

Browse files
authored
README: remove Table of Contents (#144)
It is a duplicate of SUMMARY.md
1 parent 4017a73 commit a46baf3

File tree

1 file changed

+2
-27
lines changed

1 file changed

+2
-27
lines changed

README.md

Lines changed: 2 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -4,46 +4,24 @@ An open source book about design patterns and idioms in the Rust programming
44
language that you can read [here](https://rust-unofficial.github.io/patterns/).
55

66

7-
## Contents
8-
9-
[Introduction](intro.md)
10-
7+
## TODOs
118

129
### Idioms
1310

14-
* [Constructor](idioms/ctor.md)
15-
* [Concatenating strings with `format!`](idioms/concat-format.md)
16-
* [Privacy for extensibility](idioms/priv-extend.md)
1711
* TODO stability for extensibility
1812
* TODO trait to separate visibility of methods from visibility of data (https://github.com/sfackler/rust-postgres/blob/v0.9.6/src/lib.rs#L1400)
19-
* [Collections are smart pointers](idioms/deref.md)
2013
* TODO leak amplification ("Vec::drain sets the Vec's len to 0 prematurely so that mem::forgetting Drain "only" mem::forgets more stuff. instead of exposing uninitialized memory or having to update the len on every iteration")
21-
* [Finalisation in destructors](idioms/dtor-finally.md)
2214
* TODO interior mutability - UnsafeCell, Cell, RefCell
23-
* [Iterating over an `Option`](idioms/option-iter.md)
24-
* [`Default` trait](idioms/default.md)
25-
* [Pass variables to closure](idioms/pass-var-to-closure.md)
26-
* [`mem::replace(_)` to avoid needless clones](idioms/mem-replace.md)
27-
* [Temporary mutability](idioms/temporary-mutability.md)
28-
* [On-Stack Dynamic Dispatch](idioms/on-stack-dyn-dispatch.md)
2915
* TODO FFI usage (By being mindful of how to provide Rust libraries, and make use of existing libraries across the FFI, you can get more out of benefits Rust can bring)
30-
* [Easy doc initialization](idioms/rustdoc-init.md)
3116

3217

3318
### Design patterns
3419

35-
* [Builder](patterns/builder.md)
36-
* [RAII guards](patterns/RAII.md)
37-
* [Newtype](patterns/newtype.md)
3820
* TODO iterators (to safely avoid bounds checks)
3921
* TODO closures and lifetimes (coupling to lifetime)
4022
* TODO platform-specific sub-modules (https://github.com/rust-lang/rfcs/blob/master/text/0517-io-os-reform.md#platform-specific-opt-in)
4123
* TODO Module organisation (by looking at examples such as Rusts `libstd`, and how it integrated into the Rusts source code, lessons can be learned about ergonomic project management and API design. Closely assosciated with platform-specific sub-modules)
42-
* [Entry API](patterns/entry.md) (TODO Currently just a boilerplate)
43-
* [Visitor](patterns/visitor.md)
44-
* [Fold](patterns/fold.md)
45-
* [Prefer small crates](patterns/small-crates.md)
46-
* [Contain unsafety in small modules](patterns/unsafe-mods.md)
24+
* [Entry API](patterns/entry.md) (Currently just a boilerplate)
4725
* TODO extension traits
4826
* TODO destructor bombs (ensure linear typing dynamically, e.g., https://github.com/Munksgaard/session-types/commit/0f25ccb7c3bc9f65fa8eaf538233e8fe344a189a)
4927
* TODO convertible to Foo trait for more generic generics (e.g., http://static.rust-lang.org/doc/master/std/fs/struct.File.html#method.open)
@@ -52,19 +30,16 @@ language that you can read [here](https://rust-unofficial.github.io/patterns/).
5230
* TODO composition of structs to please the borrow checker
5331
* TODO `Error` traits and `Result` forwarding
5432
* TODO graphs
55-
* [Compose structs together for better borrowing](patterns/compose-structs.md)
5633

5734

5835
### Anti-patterns
5936

6037
* TODO thread + catch_panic for exceptions
6138
* TODO Clone to satisfy the borrow checker
62-
* [Deref polymorphism](anti_patterns/deref.md)
6339
* TODO Matching all fields of a struct (back compat)
6440
* TODO wildcard matches
6541
* TODO taking an enum rather than having multiple functions
6642
* TODO `unwrap()`ing every `Result` instead of forwarding it
67-
* [`#[deny(warnings)]`](anti_patterns/deny-warnings.md)
6843

6944

7045
## Contributing

0 commit comments

Comments
 (0)