TODO Examples

[japaric]

These are some topics that need examples, but not I'm too familiar with. It would be great if someone more familiar with these topics could send a PR adding examples for these topics.

• Procedural macros New chapter on procedural macros #155
• Any
• Arc Arc chapter #104
• Ascii
• Cell
• Gc
• Mutex Mutex chapter #105
• Once
• Rc
• RefCell
• Unsafe<T>
• bitflags
• green #[start] and rustuv::event_loop vs basic::event_loop
• local_data
• log crate
• net::tcp
• rustdoc Topics for the "rustdoc" chapter #108

These are topics that I can cover, and some already appear in the book as unavailable. But I won't get angry if someone wants to give me a hand :-).

• Bottom types ! Add examples of diverging functions #146
• FFI Split current "FFI" chapter, cover more topics #114
• Phantom types Add an example about phantom types #145
• Barrier The "task" chapter is a stub #113
• Buffered{Reader,Writer}
• assert!, debug_assert!, etc.
• macros_rules Split current "macro_rules" chapter ", cover more topics #110
• os::args + getopts Topics for the "args" chapter #106
• rand Split current "rand" chapter, cover more topics #116
• regex crate
• select!
• serialize::json Topics for the JSON chapter #86
• std::hash + collections::hashmap std::hash + collections::hashmap #161
• std::io::stdio
• term crate
• unsafe blocks Split current "unsafe" chapter, cover more topics #112
• url crate
• bench Expand the "bench" chapter #115
• closures The "closure" chapter is a stub #91
• comments: //, /* */, /* /* */ */, ///, etc. Topics for the "comment" chapter #107
• formatting Topics for the formatting chapter #196
• kinds: Send, Share, Copy and Sized
• raw pointers *T Split current "unsafe" chapter, cover more topics #112
• tasks The "task" chapter is a stub #113
• testing Split the current "testing" chapter #111
• unsafe global state (static mut) Split current "unsafe" chapter, cover more topics #112
• Drop
• Process
• Result and try!
• std::io::fs
• attributes: #[test], #[crate_id], etc
• file I/O
• modules and crates
• operator overloading: Add, Sub, etc.
• simd

[jacob-hegna]

By rustdoc do you just mean how the documentation is formatted within the rust stdlib source files?

[japaric]

@jacob-hegna I have in mind something like:

• How to format comments that will be processed by rustdoc
• how to use rustdoc from the command line
• mention output formats available
• mention that the official docs are built using rustdoc
• show input source code and show how the output looks (maybe we can use official docs for this)

[kud1ing]

Some inspiration for the topic on crates: https://mail.mozilla.org/pipermail/rust-dev/2014-May/009767.html

I've never thought about the compilation unit <=> C/C++ object file analogy before.

[alan-andrade]

I'll cover Arc and Mutex.

[japaric]

I'll cover Arc and Mutex.

Awesome \o/. I have opened #104 and #105 to keep track of this.

[vojtechkral]

I'm working on a chapter on std::fmt traits + an example on how to implement std::fmt::Show → #128

[mdinger]

Please add Phantom types to the list. See #145 for more info.
[EDIT] He added it.

[abonander]

How's your progress on collections::HashMap? I've been toying with it and I think I worked through a few frustrating nuances with it and lifetimes.

[japaric]

@cybergeek94 That chapter is not taken at the moment, if you want to work on it, please open an issue mentioning that you'll work on it. And, if you can, leave a list of the topics you plan to cover (check issues tagged with the C-new label for an example).

[abonander]

I think I want to do Rc next. The docs have a neat example that sort of lines up with a relational model concept, and then continues with rc::Weak to show doubly-linked records. I could extend that example. I could also use the Drop trait to show the user where the object owned by Rc gets destroyed in different scopes.

The Weak example in the docs plays around with RefCell for a more flexible borrowing example. That should probably be covered before Rc.

I can cover RefCell and/or Rc, if neither is taken.

I also want to express my interest in the regex crate, though someone else can take that if they get to it first.

[sinistersnare]

A few of these crates dont necessarily exist in the Rust repo anymore. Gc is gone, so should be removed, along with green

Also I do not know if we should do url also, because it is no longer in tree.

[strega-nil]

I agree with @sinistersnare, we should definitely remove url.

[kmcallister]

The official plugins guide has examples for procedural macros as well as lint plugins.

[steveklabnik]

I'm not going to track these kinds of things on the tracker. More examples are always welcome.