rust/comprehensive-rust
1
0
Fork 0
mirror of https://github.com/google/comprehensive-rust.git synced 2025-07-03 21:39:51 +02:00
Code Issues Releases Activity

Format all Markdown files with dprint (#1157)

Browse Source 
This is the result of running `dprint fmt` after removing `src/` from
the list of excluded directories.

This also reformats the Rust code: we might want to tweak this a bit in
the future since some of the changes removes the hand-formatting. Of
course, this formatting can be seen as a mis-feature, so maybe this is
good overall.

Thanks to mdbook-i18n-helpers 0.2, the POT file is nearly unchanged
after this, meaning that all existing translations remain valid! A few
messages were changed because of stray whitespace characters:

     msgid ""
     "Slices always borrow from another object. In this example, `a` has to remain "
    -"'alive' (in scope) for at least as long as our slice. "
    +"'alive' (in scope) for at least as long as our slice."
     msgstr ""

The formatting is enforced in CI and we will have to see how annoying
this is in practice for the many contributors. If it becomes annoying,
we should look into fixing dprint/check#11 so that `dprint` can annotate
the lines that need fixing directly, then I think we can consider more
strict formatting checks.

I added more customization to `rustfmt.toml`. This is to better emulate
the dense style used in the course:

- `max_width = 85` allows lines to take up the full width available in
our code blocks (when taking margins and the line numbers into account).
- `wrap_comments = true` ensures that we don't show very long comments
in the code examples. I edited some comments to shorten them and avoid
unnecessary line breaks — please trim other unnecessarily long comments
when you see them! Remember we're writing code for slides 😄
- `use_small_heuristics = "Max"` allows for things like struct literals
and if-statements to take up the full line width configured above.

The formatting settings apply to all our Rust code right now — I think
we could improve this with https://github.com/dprint/dprint/issues/711
which lets us add per-directory `dprint` configuration files. However,
the `inherit: true` setting is not yet implemented (as far as I can
tell), so a nested configuration file will have to copy most or all of
the top-level file.
This commit is contained in:
Martin Geisler
2023-12-31 00:15:07 +01:00
committed by GitHub
parent f43e72e0ad
commit c9f66fd425
302 changed files with 3067 additions and 2622 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/modules/exercise.md
View File

@ -4,13 +4,13 @@ minutes: 20
# Exercise: Modules for the GUI Library
In this exercise, you will reorganize the GUI Library exercise from the
"Methods and Traits" segment of the course into a collection of modules. It is
typical to put each type or set of closely-related types into its own module,
so each widget type should get its own module.
In this exercise, you will reorganize the GUI Library exercise from the "Methods
and Traits" segment of the course into a collection of modules. It is typical to
put each type or set of closely-related types into its own module, so each
widget type should get its own module.
If you no longer have your version, that's fine - refer back to the [provided
solution](../methods-and-traits/solution.html).
If you no longer have your version, that's fine - refer back to the
[provided solution](../methods-and-traits/solution.html).
## Cargo Setup

30
src/modules/filesystem.md
View File

@ -11,12 +11,13 @@ mod garden;
```
This tells rust that the `garden` module content is found at `src/garden.rs`.
Similarly, a `garden::vegetables` module can be found at `src/garden/vegetables.rs`.
Similarly, a `garden::vegetables` module can be found at
`src/garden/vegetables.rs`.
The `crate` root is in:
* `src/lib.rs` (for a library crate)
* `src/main.rs` (for a binary crate)
- `src/lib.rs` (for a library crate)
- `src/main.rs` (for a binary crate)
Modules defined in files can be documented, too, using "inner doc comments".
These document the item that contains them -- in this case, a module.
@ -26,24 +27,29 @@ These document the item that contains them -- in this case, a module.
//! implementation.
// Re-export types from this module.
pub use seeds::SeedPacket;
pub use garden::Garden;
pub use seeds::SeedPacket;
/// Sow the given seed packets.
pub fn sow(seeds: Vec<SeedPacket>) { todo!() }
pub fn sow(seeds: Vec<SeedPacket>) {
todo!()
}
/// Harvest the produce in the garden that is ready.
pub fn harvest(garden: &mut Garden) { todo!() }
pub fn harvest(garden: &mut Garden) {
todo!()
}
```
<details>
* Before Rust 2018, modules needed to be located at `module/mod.rs` instead of `module.rs`, and this is still a working alternative for editions after 2018.
- Before Rust 2018, modules needed to be located at `module/mod.rs` instead of
`module.rs`, and this is still a working alternative for editions after 2018.
* The main reason to introduce `filename.rs` as alternative to `filename/mod.rs`
- The main reason to introduce `filename.rs` as alternative to `filename/mod.rs`
was because many files named `mod.rs` can be hard to distinguish in IDEs.
* Deeper nesting can use folders, even if the main module is a file:
- Deeper nesting can use folders, even if the main module is a file:
```ignore
src/
@ -53,14 +59,14 @@ pub fn harvest(garden: &mut Garden) { todo!() }
└── sub_module.rs
```
* The place rust will look for modules can be changed with a compiler directive:
- The place rust will look for modules can be changed with a compiler directive:
```rust,ignore
#[path = "some/path.rs"]
mod some_module;
```
This is useful, for example, if you would like to place tests for a module in a file named
`some_module_test.rs`, similar to the convention in Go.
This is useful, for example, if you would like to place tests for a module in
a file named `some_module_test.rs`, similar to the convention in Go.
</details>

8
src/modules/modules.md
View File

@ -29,8 +29,10 @@ fn main() {
<details>
* Packages provide functionality and include a `Cargo.toml` file that describes how to build a bundle of 1+ crates.
* Crates are a tree of modules, where a binary crate creates an executable and a library crate compiles to a library.
* Modules define organization, scope, and are the focus of this section.
- Packages provide functionality and include a `Cargo.toml` file that describes
how to build a bundle of 1+ crates.
- Crates are a tree of modules, where a binary crate creates an executable and a
library crate compiles to a library.
- Modules define organization, scope, and are the focus of this section.
</details>

26
src/modules/paths.md
View File

@ -4,8 +4,8 @@ minutes: 10
# use, super, self
A module can bring symbols from another module into scope with `use`.
You will typically see something like this at the top of each module:
A module can bring symbols from another module into scope with `use`. You will
typically see something like this at the top of each module:
```rust,editable
use std::collections::HashSet;
@ -17,16 +17,16 @@ use std::process::abort;
Paths are resolved as follows:
1. As a relative path:
* `foo` or `self::foo` refers to `foo` in the current module,
* `super::foo` refers to `foo` in the parent module.
- `foo` or `self::foo` refers to `foo` in the current module,
- `super::foo` refers to `foo` in the parent module.
2. As an absolute path:
* `crate::foo` refers to `foo` in the root of the current crate,
* `bar::foo` refers to `foo` in the `bar` crate.
- `crate::foo` refers to `foo` in the root of the current crate,
- `bar::foo` refers to `foo` in the `bar` crate.
<details>
* It is common to "re-export" symbols at a shorter path. For example, the
- It is common to "re-export" symbols at a shorter path. For example, the
top-level `lib.rs` in a crate might have
```rust,ignore
@ -39,14 +39,14 @@ Paths are resolved as follows:
making `DiskStorage` and `NetworkStorage` available to other crates with a
convenient, short path.
* For the most part, only items that appear in a module need to be `use`'d.
However, a trait must be in scope to call any methods on that trait, even if
a type implementing that trait is already in scope. For example, to use the
- For the most part, only items that appear in a module need to be `use`'d.
However, a trait must be in scope to call any methods on that trait, even if a
type implementing that trait is already in scope. For example, to use the
`read_to_string` method on a type implementing the `Read` trait, you need to
`use std::io::Read`.
* The `use` statement can have a wildcard: `use std::io::*`. This is
discouraged because it is not clear which items are imported, and those might
change over time.
- The `use` statement can have a wildcard: `use std::io::*`. This is discouraged
because it is not clear which items are imported, and those might change over
time.
</details>

24
src/modules/solution.md
View File

@ -62,20 +62,14 @@ pub struct Label {
impl Label {
pub fn new(label: &str) -> Label {
Label {
label: label.to_owned(),
}
Label { label: label.to_owned() }
}
}
impl Widget for Label {
fn width(&self) -> usize {
// ANCHOR_END: Label-width
self.label
.lines()
.map(|line| line.chars().count())
.max()
.unwrap_or(0)
self.label.lines().map(|line| line.chars().count()).max().unwrap_or(0)
}
// ANCHOR: Label-draw_into
@ -96,9 +90,7 @@ pub struct Button {
impl Button {
pub fn new(label: &str) -> Button {
Button {
label: Label::new(label),
}
Button { label: Label::new(label) }
}
}
@ -135,10 +127,7 @@ pub struct Window {
impl Window {
pub fn new(title: &str) -> Window {
Window {
title: title.to_owned(),
widgets: Vec::new(),
}
Window { title: title.to_owned(), widgets: Vec::new() }
}
pub fn add_widget(&mut self, widget: Box<dyn Widget>) {
@ -192,9 +181,8 @@ use widgets::Widget;
fn main() {
let mut window = widgets::Window::new("Rust GUI Demo 1.23");
window.add_widget(Box::new(widgets::Label::new(
"This is a small text GUI demo.",
)));
window
.add_widget(Box::new(widgets::Label::new("This is a small text GUI demo.")));
window.add_widget(Box::new(widgets::Button::new("Click me!")));
window.draw();
}

21
src/modules/visibility.md
View File

@ -6,9 +6,9 @@ minutes: 5
Modules are a privacy boundary:
* Module items are private by default (hides implementation details).
* Parent and sibling items are always visible.
* In other words, if an item is visible in module `foo`, it's visible in all the
- Module items are private by default (hides implementation details).
- Parent and sibling items are always visible.
- In other words, if an item is visible in module `foo`, it's visible in all the
descendants of `foo`.
```rust,editable
@ -40,13 +40,16 @@ fn main() {
<details>
* Use the `pub` keyword to make modules public.
- Use the `pub` keyword to make modules public.
Additionally, there are advanced `pub(...)` specifiers to restrict the scope of public visibility.
Additionally, there are advanced `pub(...)` specifiers to restrict the scope of
public visibility.
* See the [Rust Reference](https://doc.rust-lang.org/reference/visibility-and-privacy.html#pubin-path-pubcrate-pubsuper-and-pubself).
* Configuring `pub(crate)` visibility is a common pattern.
* Less commonly, you can give visibility to a specific path.
* In any case, visibility must be granted to an ancestor module (and all of its descendants).
- See the
[Rust Reference](https://doc.rust-lang.org/reference/visibility-and-privacy.html#pubin-path-pubcrate-pubsuper-and-pubself).
- Configuring `pub(crate)` visibility is a common pattern.
- Less commonly, you can give visibility to a specific path.
- In any case, visibility must be granted to an ancestor module (and all of its
descendants).
</details>