From 6f69cd6387bf1975dfc760b939d607c49ff126cb Mon Sep 17 00:00:00 2001 From: Pascal Hertleif Date: Mon, 18 May 2015 20:56:00 +0200 Subject: [PATCH] TRPL: Add `rust` Marker to Some Code Block This adds strictly more information to the source files and reduces the need for customized tooling to render the book. (While this should not change the output of _rustbook_, it is very useful when rendering the sources with external tools like Pandoc.) --- src/doc/trpl/borrow-and-asref.md | 2 +- src/doc/trpl/box-syntax-and-patterns.md | 2 +- src/doc/trpl/concurrency.md | 12 ++--- src/doc/trpl/crates-and-modules.md | 2 +- src/doc/trpl/documentation.md | 58 ++++++++++++------------- src/doc/trpl/ffi.md | 12 ++--- src/doc/trpl/functions.md | 4 +- src/doc/trpl/generics.md | 2 +- src/doc/trpl/guessing-game.md | 2 +- src/doc/trpl/inline-assembly.md | 14 +++--- src/doc/trpl/intrinsics.md | 2 +- src/doc/trpl/lang-items.md | 2 +- src/doc/trpl/macros.md | 1 + src/doc/trpl/method-syntax.md | 6 +-- src/doc/trpl/mutability.md | 2 +- src/doc/trpl/no-stdlib.md | 2 +- src/doc/trpl/primitive-types.md | 4 +- src/doc/trpl/strings.md | 2 +- src/doc/trpl/testing.md | 2 +- src/doc/trpl/traits.md | 8 ++-- src/doc/trpl/vectors.md | 2 +- 21 files changed, 72 insertions(+), 71 deletions(-) diff --git a/src/doc/trpl/borrow-and-asref.md b/src/doc/trpl/borrow-and-asref.md index f5f314f1c21..dbde2be369b 100644 --- a/src/doc/trpl/borrow-and-asref.md +++ b/src/doc/trpl/borrow-and-asref.md @@ -51,7 +51,7 @@ kind of borrowed value. Slices are an area where this is especially true: you can have both an `&[T]` or a `&mut [T]`. If we wanted to accept both of these types, `Borrow` is up for it: -``` +```rust use std::borrow::Borrow; use std::fmt::Display; diff --git a/src/doc/trpl/box-syntax-and-patterns.md b/src/doc/trpl/box-syntax-and-patterns.md index 839f07d9843..dc1abc5d06a 100644 --- a/src/doc/trpl/box-syntax-and-patterns.md +++ b/src/doc/trpl/box-syntax-and-patterns.md @@ -5,7 +5,7 @@ Also it is not possible in stable Rust to destructure a `Box` in a match pattern. The unstable `box` keyword can be used to both create and destructure a `Box`. An example usage would be: -``` +```rust #![feature(box_syntax, box_patterns)] fn main() { diff --git a/src/doc/trpl/concurrency.md b/src/doc/trpl/concurrency.md index 3c64e0b14de..ccd769089d2 100644 --- a/src/doc/trpl/concurrency.md +++ b/src/doc/trpl/concurrency.md @@ -59,7 +59,7 @@ place! Rust's standard library provides a library for threads, which allow you to run Rust code in parallel. Here's a basic example of using `std::thread`: -``` +```rust use std::thread; fn main() { @@ -73,7 +73,7 @@ The `thread::spawn()` method accepts a closure, which is executed in a new thread. It returns a handle to the thread, that can be used to wait for the child thread to finish and extract its result: -``` +```rust use std::thread; fn main() { @@ -189,7 +189,7 @@ guard across thread boundaries, which gives us our error. We can use `Arc` to fix this. Here's the working version: -``` +```rust use std::sync::{Arc, Mutex}; use std::thread; @@ -248,7 +248,7 @@ threads with each other. Let's talk about one of them: channels. Here's a version of our code that uses channels for synchronization, rather than waiting for a specific time: -``` +```rust use std::sync::{Arc, Mutex}; use std::thread; use std::sync::mpsc; @@ -281,7 +281,7 @@ a simple `()` down the channel, and then wait for ten of them to come back. While this channel is just sending a generic signal, we can send any data that is `Send` over the channel! -``` +```rust use std::thread; use std::sync::mpsc; @@ -311,7 +311,7 @@ the answer, and then it `send()`s us the answer over the channel. A `panic!` will crash the currently executing thread. You can use Rust's threads as a simple isolation mechanism: -``` +```rust use std::thread; let result = thread::spawn(move || { diff --git a/src/doc/trpl/crates-and-modules.md b/src/doc/trpl/crates-and-modules.md index 3ab3401e612..d5970e2e491 100644 --- a/src/doc/trpl/crates-and-modules.md +++ b/src/doc/trpl/crates-and-modules.md @@ -75,7 +75,7 @@ above. To define each of our modules, we use the `mod` keyword. Let’s make our `src/lib.rs` look like this: -``` +```rust mod english { mod greetings { } diff --git a/src/doc/trpl/documentation.md b/src/doc/trpl/documentation.md index b28343e7fb9..4accba90e6c 100644 --- a/src/doc/trpl/documentation.md +++ b/src/doc/trpl/documentation.md @@ -42,7 +42,7 @@ Documentation comments are written in Markdown. Rust keeps track of these comments, and uses them when generating documentation. This is important when documenting things like enums: -``` +```rust /// The `Option` type. See [the module level documentation](../) for more. enum Option { /// No value @@ -80,7 +80,7 @@ thing after that last comment. Anyway, let's cover each part of this comment in detail: -``` +```rust /// Constructs a new `Rc`. # fn foo() {} ``` @@ -88,7 +88,7 @@ Anyway, let's cover each part of this comment in detail: The first line of a documentation comment should be a short summary of its functionality. One sentence. Just the basics. High level. -``` +```rust /// /// Other details about constructing `Rc`s, maybe describing complicated /// semantics, maybe additional options, all kinds of stuff. @@ -101,7 +101,7 @@ we could have added more explanation in a new paragraph. #### Special sections -``` +```rust /// # Examples # fn foo() {} ``` @@ -110,7 +110,7 @@ Next, are special sections. These are indicated with a header, `#`. There are three kinds of headers that are commonly used. They aren't special syntax, just convention, for now. -``` +```rust /// # Panics # fn foo() {} ``` @@ -120,7 +120,7 @@ usually indicated by panics, which kill the whole current thread at the very least. If your function has a non-trivial contract like this, that is detected/enforced by panics, documenting it is very important. -``` +```rust /// # Failures # fn foo() {} ``` @@ -130,7 +130,7 @@ conditions under which it returns `Err(E)` is a nice thing to do. This is slightly less important than `Panics`, because failure is encoded into the type system, but it's still a good thing to do. -``` +```rust /// # Safety # fn foo() {} ``` @@ -138,7 +138,7 @@ system, but it's still a good thing to do. If your function is `unsafe`, you should explain which invariants the caller is responsible for upholding. -``` +```rust /// # Examples /// /// ``` @@ -154,7 +154,7 @@ method, and your users will love you for it. These examples go inside of code block annotations, which we'll talk about in a moment, and can have more than one section: -``` +```rust /// # Examples /// /// Simple `&str` patterns: @@ -179,7 +179,7 @@ Let's discuss the details of these code blocks. To write some Rust code in a comment, use the triple graves: -``` +```rust /// ``` /// println!("Hello, world"); /// ``` @@ -188,7 +188,7 @@ To write some Rust code in a comment, use the triple graves: If you want something that's not Rust code, you can add an annotation: -``` +```rust /// ```c /// printf("Hello, world\n"); /// ``` @@ -208,7 +208,7 @@ generate the documentation. Let's discuss our sample example documentation: -``` +```rust /// ``` /// println!("Hello, world"); /// ``` @@ -219,7 +219,7 @@ You'll notice that you don't need a `fn main()` or anything here. `rustdoc` will automatically add a main() wrapper around your code, and in the right place. For example: -``` +```rust /// ``` /// use std::rc::Rc; /// @@ -230,7 +230,7 @@ For example: This will end up testing: -``` +```rust fn main() { use std::rc::Rc; let five = Rc::new(5); @@ -259,7 +259,7 @@ with `///` we've been talking about? The raw text: looks different than the output: -``` +```rust /// Some documentation. # fn foo() {} ``` @@ -274,7 +274,7 @@ it makes the example more clear. You can use this technique to explain longer examples in detail, while still preserving the testability of your documentation. For example, this code: -``` +```rust let x = 5; let y = 6; println!("{}", x + y); @@ -284,7 +284,7 @@ Here's an explanation, rendered: First, we set `x` to five: -``` +```rust let x = 5; # let y = 6; # println!("{}", x + y); @@ -292,7 +292,7 @@ let x = 5; Next, we set `y` to six: -``` +```rust # let x = 5; let y = 6; # println!("{}", x + y); @@ -300,7 +300,7 @@ let y = 6; Finally, we print the sum of `x` and `y`: -``` +```rust # let x = 5; # let y = 6; println!("{}", x + y); @@ -340,7 +340,7 @@ explanation. Here’s an example of documenting a macro: -``` +```rust /// Panic with a given message unless an expression evaluates to true. /// /// # Examples @@ -388,7 +388,7 @@ but with a binary, there’s nothing to link to. There are a few more annotations that are useful to help `rustdoc` do the right thing when testing your code: -``` +```rust /// ```ignore /// fn foo() { /// ``` @@ -400,7 +400,7 @@ what you want, as it's the most generic. Instead, consider annotating it with `text` if it's not code, or using `#`s to get a working example that only shows the part you care about. -``` +```rust /// ```should_panic /// assert!(false); /// ``` @@ -410,7 +410,7 @@ only shows the part you care about. `should_panic` tells `rustdoc` that the code should compile correctly, but not actually pass as a test. -``` +```rust /// ```no_run /// loop { /// println!("Hello, world"); @@ -427,7 +427,7 @@ which you would want to make sure compile, but might run in an infinite loop! Rust has another kind of doc comment, `//!`. This comment doesn't document the next item, but the enclosing item. In other words: -``` +```rust mod foo { //! This is documentation for the `foo` module. //! @@ -440,7 +440,7 @@ mod foo { This is where you'll see `//!` used most often: for module documentation. If you have a module in `foo.rs`, you'll often open its code and see this: -``` +```rust //! A module for using `foo`s. //! //! The `foo` module contains a lot of useful functionality blah blah blah @@ -461,7 +461,7 @@ are written in Markdown, they're often `.md` files. When you write documentation in Markdown files, you don't need to prefix the documentation with comments. For example: -``` +```rust /// # Examples /// /// ``` @@ -499,7 +499,7 @@ This `%` line needs to be the very first line of the file. At a deeper level, documentation comments are sugar for documentation attributes: -``` +```rust /// this # fn foo() {} @@ -509,7 +509,7 @@ At a deeper level, documentation comments are sugar for documentation attributes are the same, as are these: -``` +```rust //! this #![doc="/// this"] @@ -546,7 +546,7 @@ pub use foo::bar; You can control a few aspects of the HTML that `rustdoc` generates through the `#![doc]` version of the attribute: -``` +```rust #![doc(html_logo_url = "http://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "http://www.rust-lang.org/favicon.ico", html_root_url = "http://doc.rust-lang.org/")]; diff --git a/src/doc/trpl/ffi.md b/src/doc/trpl/ffi.md index 2c5e6b2e5fc..9ede835e521 100644 --- a/src/doc/trpl/ffi.md +++ b/src/doc/trpl/ffi.md @@ -81,7 +81,7 @@ vectors as pointers to memory. Rust's vectors are guaranteed to be a contiguous length is number of elements currently contained, and the capacity is the total size in elements of the allocated memory. The length is less than or equal to the capacity. -``` +```rust # #![feature(libc)] # extern crate libc; # use libc::{c_int, size_t}; @@ -106,7 +106,7 @@ required capacity to hold the compressed output. The vector can then be passed t `snappy_compress` function as an output parameter. An output parameter is also passed to retrieve the true length after compression for setting the length. -``` +```rust # #![feature(libc)] # extern crate libc; # use libc::{size_t, c_int}; @@ -133,7 +133,7 @@ pub fn compress(src: &[u8]) -> Vec { Decompression is similar, because snappy stores the uncompressed size as part of the compression format and `snappy_uncompressed_length` will retrieve the exact buffer size required. -``` +```rust # #![feature(libc)] # extern crate libc; # use libc::{size_t, c_int}; @@ -375,7 +375,7 @@ the compiler that the unsafety does not leak out of the block. Unsafe functions, on the other hand, advertise it to the world. An unsafe function is written like this: -``` +```rust unsafe fn kaboom(ptr: *const i32) -> i32 { *ptr } ``` @@ -439,7 +439,7 @@ Most foreign code exposes a C ABI, and Rust uses the platform's C calling conven calling foreign functions. Some foreign functions, most notably the Windows API, use other calling conventions. Rust provides a way to tell the compiler which convention to use: -``` +```rust # #![feature(libc)] extern crate libc; @@ -516,7 +516,7 @@ function pointer using the C ABI. You may wish to compile Rust code in a way so that it can be called from C. This is fairly easy, but requires a few things: -``` +```rust #[no_mangle] pub extern fn hello_rust() -> *const u8 { "Hello, world!\0".as_ptr() diff --git a/src/doc/trpl/functions.md b/src/doc/trpl/functions.md index 87af48532a0..21a29f00599 100644 --- a/src/doc/trpl/functions.md +++ b/src/doc/trpl/functions.md @@ -146,7 +146,7 @@ expression, although its value is not particularly useful. Unlike other languages where an assignment evaluates to the assigned value (e.g. `5` in the previous example), in Rust the value of an assignment is an empty tuple `()`: -``` +```rust let mut y = 5; let x = (y = 6); // x has the value `()`, not `6` @@ -204,7 +204,7 @@ time. Rust has some special syntax for ‘diverging functions’, which are functions that do not return: -``` +```rust fn diverges() -> ! { panic!("This function never returns!"); } diff --git a/src/doc/trpl/generics.md b/src/doc/trpl/generics.md index 517a6e60642..f8f1962e0cf 100644 --- a/src/doc/trpl/generics.md +++ b/src/doc/trpl/generics.md @@ -110,7 +110,7 @@ Generic functions are most useful with ‘trait bounds’, which we’ll cover i You can store a generic type in a `struct` as well: -``` +```rust struct Point { x: T, y: T, diff --git a/src/doc/trpl/guessing-game.md b/src/doc/trpl/guessing-game.md index a2136431cb3..4220b4d04af 100644 --- a/src/doc/trpl/guessing-game.md +++ b/src/doc/trpl/guessing-game.md @@ -151,7 +151,7 @@ take a name on the left hand side, it actually accepts a ‘[pattern][patterns]’. We’ll use patterns more later. It’s easy enough to use for now: -``` +```rust let foo = 5; // immutable. let mut bar = 5; // mutable ``` diff --git a/src/doc/trpl/inline-assembly.md b/src/doc/trpl/inline-assembly.md index 58c2a982dd3..4d9166d63bf 100644 --- a/src/doc/trpl/inline-assembly.md +++ b/src/doc/trpl/inline-assembly.md @@ -25,7 +25,7 @@ crate to allow) and of course requires an `unsafe` block. The `assembly template` is the only required parameter and must be a literal string (i.e. `""`) -``` +```rust #![feature(asm)] #[cfg(any(target_arch = "x86", target_arch = "x86_64"))] @@ -51,7 +51,7 @@ fn main() { Output operands, input operands, clobbers and options are all optional but you must add the right number of `:` if you skip them: -``` +```rust # #![feature(asm)] # #[cfg(any(target_arch = "x86", target_arch = "x86_64"))] # fn main() { unsafe { @@ -65,7 +65,7 @@ asm!("xor %eax, %eax" Whitespace also doesn't matter: -``` +```rust # #![feature(asm)] # #[cfg(any(target_arch = "x86", target_arch = "x86_64"))] # fn main() { unsafe { @@ -79,7 +79,7 @@ Input and output operands follow the same format: `: "constraints1"(expr1), "constraints2"(expr2), ..."`. Output operand expressions must be mutable lvalues, or not yet assigned: -``` +```rust # #![feature(asm)] # #[cfg(any(target_arch = "x86", target_arch = "x86_64"))] fn add(a: i32, b: i32) -> i32 { @@ -106,7 +106,7 @@ you want, and you are required to put the specific size of the operand. This is useful for very low level programming, where which register you use is important: -``` +```rust # #![feature(asm)] # #[cfg(any(target_arch = "x86", target_arch = "x86_64"))] # unsafe fn read_byte_in(port: u16) -> u8 { @@ -123,7 +123,7 @@ different values so we use the clobbers list to indicate to the compiler not to assume any values loaded into those registers will stay valid. -``` +```rust # #![feature(asm)] # #[cfg(any(target_arch = "x86", target_arch = "x86_64"))] # fn main() { unsafe { @@ -155,7 +155,7 @@ Current valid options are: the compiler to insert its usual stack alignment code 3. *intel* - use intel syntax instead of the default AT&T. -``` +```rust # #![feature(asm)] # #[cfg(any(target_arch = "x86", target_arch = "x86_64"))] # fn main() { diff --git a/src/doc/trpl/intrinsics.md b/src/doc/trpl/intrinsics.md index 25f7c544931..e0a8bb59e34 100644 --- a/src/doc/trpl/intrinsics.md +++ b/src/doc/trpl/intrinsics.md @@ -10,7 +10,7 @@ context, but wished to be able to `transmute` between types, and perform efficient pointer arithmetic, one would import those functions via a declaration like -``` +```rust # #![feature(intrinsics)] # fn main() {} diff --git a/src/doc/trpl/lang-items.md b/src/doc/trpl/lang-items.md index 4808ad6ff1f..8e7504c2f18 100644 --- a/src/doc/trpl/lang-items.md +++ b/src/doc/trpl/lang-items.md @@ -15,7 +15,7 @@ For example, `Box` pointers require two lang items, one for allocation and one for deallocation. A freestanding program that uses the `Box` sugar for dynamic allocations via `malloc` and `free`: -``` +```rust #![feature(lang_items, box_syntax, start, no_std, libc)] #![no_std] diff --git a/src/doc/trpl/macros.md b/src/doc/trpl/macros.md index d504fab206d..ce06987013d 100644 --- a/src/doc/trpl/macros.md +++ b/src/doc/trpl/macros.md @@ -698,6 +698,7 @@ assert_eq!(5, 3 + 2); assert!(5 < 3); assert_eq!(5, 3); ``` + ## try! `try!` is used for error handling. It takes something that can return a diff --git a/src/doc/trpl/method-syntax.md b/src/doc/trpl/method-syntax.md index a166e4acc4e..e5f490e15e1 100644 --- a/src/doc/trpl/method-syntax.md +++ b/src/doc/trpl/method-syntax.md @@ -89,7 +89,7 @@ So, now we know how to call a method, such as `foo.bar()`. But what about our original example, `foo.bar().baz()`? This is called ‘method chaining’, and we can do it by returning `self`. -``` +```rust struct Circle { x: f64, y: f64, @@ -117,7 +117,7 @@ fn main() { Check the return type: -``` +```rust # struct Circle; # impl Circle { fn grow(&self) -> Circle { @@ -167,7 +167,7 @@ and `y` attributes will be `0.0`, and the `radius` will be `1.0`. Rust doesn’t have method overloading, named arguments, or variable arguments. We employ the builder pattern instead. It looks like this: -``` +```rust struct Circle { x: f64, y: f64, diff --git a/src/doc/trpl/mutability.md b/src/doc/trpl/mutability.md index 7186c65cdf4..fe41def4d7c 100644 --- a/src/doc/trpl/mutability.md +++ b/src/doc/trpl/mutability.md @@ -161,7 +161,7 @@ b.x = 10; // error: cannot assign to immutable field `b.x` However, by using `Cell`, you can emulate field-level mutability: -``` +```rust use std::cell::Cell; struct Point { diff --git a/src/doc/trpl/no-stdlib.md b/src/doc/trpl/no-stdlib.md index 67db919c59f..0a985334b5e 100644 --- a/src/doc/trpl/no-stdlib.md +++ b/src/doc/trpl/no-stdlib.md @@ -20,7 +20,7 @@ default shim for the C `main` function with your own. The function marked `#[start]` is passed the command line parameters in the same format as C: -``` +```rust #![feature(lang_items, start, no_std, libc)] #![no_std] diff --git a/src/doc/trpl/primitive-types.md b/src/doc/trpl/primitive-types.md index d3bf61434c9..027909dd058 100644 --- a/src/doc/trpl/primitive-types.md +++ b/src/doc/trpl/primitive-types.md @@ -251,7 +251,7 @@ This pattern is very powerful, and we’ll see it repeated more later. You can disambiguate a single-element tuple from a value in parentheses with a comma: -``` +```rust (0,); // single-element tuple (0); // zero in parentheses ``` @@ -283,7 +283,7 @@ documentation][tuple]. Functions also have a type! They look like this: -``` +```rust fn foo(x: i32) -> i32 { x } let x: fn(i32) -> i32 = foo; diff --git a/src/doc/trpl/strings.md b/src/doc/trpl/strings.md index ece2c390be3..abe17a96b39 100644 --- a/src/doc/trpl/strings.md +++ b/src/doc/trpl/strings.md @@ -38,7 +38,7 @@ println!("{}", s); `String`s will coerce into `&str` with an `&`: -``` +```rust fn takes_slice(slice: &str) { println!("Got: {}", slice); } diff --git a/src/doc/trpl/testing.md b/src/doc/trpl/testing.md index 45f87a67405..f5fdb8f8590 100644 --- a/src/doc/trpl/testing.md +++ b/src/doc/trpl/testing.md @@ -195,7 +195,7 @@ parameter can be added to the `should_panic` attribute. The test harness will make sure that the failure message contains the provided text. A safer version of the example above would be: -``` +```rust #[test] #[should_panic(expected = "assertion failed")] fn it_works() { diff --git a/src/doc/trpl/traits.md b/src/doc/trpl/traits.md index 889205ad5d8..c837755a386 100644 --- a/src/doc/trpl/traits.md +++ b/src/doc/trpl/traits.md @@ -252,7 +252,7 @@ Writing functions with only a few generic types and a small number of trait bounds isn’t too bad, but as the number increases, the syntax gets increasingly awkward: -``` +```rust use std::fmt::Debug; fn foo(x: T, y: K) { @@ -267,7 +267,7 @@ far right. The bounds are getting in the way. Rust has a solution, and it’s called a ‘`where` clause’: -``` +```rust use std::fmt::Debug; fn foo(x: T, y: K) { @@ -293,7 +293,7 @@ All you need to do is leave off the bounds when defining your type parameters, and then add `where` after the parameter list. For longer lists, whitespace can be added: -``` +```rust use std::fmt::Debug; fn bar(x: T, y: K) @@ -310,7 +310,7 @@ This flexibility can add clarity in complex situations. `where` is also more powerful than the simpler syntax. For example: -``` +```rust trait ConvertTo { fn convert(&self) -> Output; } diff --git a/src/doc/trpl/vectors.md b/src/doc/trpl/vectors.md index 6170bdb86ea..d8b894a2f65 100644 --- a/src/doc/trpl/vectors.md +++ b/src/doc/trpl/vectors.md @@ -16,7 +16,7 @@ this is just convention.) There’s an alternate form of `vec!` for repeating an initial value: -``` +```rust let v = vec![0; 10]; // ten zeroes ``` -- 2.44.0