rust/comprehensive-rust
1
0
Fork 0
mirror of https://github.com/google/comprehensive-rust.git synced 2024-12-17 23:23:43 +02:00
Code Issues Releases Activity
638 Commits 18 Branches 0 Tags 50 MiB
f0043637e2
Commit Graph

482 Commits

Author SHA1 Message Date
Andrew Walbran
0fa73286b9 Add raw MMIO example. 2023-03-20 14:26:57 +00:00
Andrew Walbran
2545e40d21 Note use of embedded_hal trait. 2023-03-20 14:26:57 +00:00
Andrew Walbran
16b8efefa2 Add config for cargo-embed. 2023-03-20 14:26:57 +00:00
Andrew Walbran
2c8eb761c4 Use micro:bit v2 for PAC and HAL examples too. 2023-03-20 14:26:57 +00:00
Andrew Walbran
5ad0a593f8 Add board support crate example. 2023-03-20 14:26:57 +00:00
Andrew Walbran
b852b6195f xgettext doesn't like formatting in SUMMARY. 2023-03-20 14:26:57 +00:00
Andrew Walbran
af0d97d1a7 Fix mdbook test. 2023-03-20 14:26:57 +00:00
Andrew Walbran
354834c711 Template, hint and extension for compass exercise. 2023-03-20 14:26:57 +00:00
Andrew Walbran
062129546a Temperature logger is no more. 2023-03-20 14:26:57 +00:00
Andrew Walbran
95099e29a6 Mention tools to install. 2023-03-20 14:26:57 +00:00
Andrew Walbran
deff63f9a5 cargo-embed config 2023-03-20 14:26:57 +00:00
Andrew Walbran
78d1fc2836 Fill in solution for compass exercise. 2023-03-20 14:26:57 +00:00
Andrew Walbran
fb2a81186b Initialise I2C bus. 2023-03-20 14:26:57 +00:00
Andrew Walbran
026cdca2b7 Use micro:bit v2 for temperature logger example. 2023-03-20 14:26:57 +00:00
Andrew Walbran
b8b387c504 Mention board support crates and other tools. 2023-03-20 14:26:57 +00:00
Andrew Walbran
b02af7be50 Keep alloc-example out of workspace. 2023-03-20 14:26:57 +00:00
Andrew Walbran
e21a83d5e8 Start or temperature logger exercise. 2023-03-20 14:26:57 +00:00
Andrew Walbran
5e0f4da4b3 Mention some other projects. 2023-03-20 14:26:57 +00:00
Andrew Walbran
baf81ee795 Note some supported devices. 2023-03-20 14:26:57 +00:00
Andrew Walbran
ac046661bf Exclude imports and other boilerplate from page. 
It was getting too long.
 2023-03-20 14:26:57 +00:00
Andrew Walbran
100341aa9f Add page about type-state pattern. 2023-03-20 14:26:57 +00:00
Andrew Walbran
65749777c9 Write about embedded-hal 2023-03-20 14:26:57 +00:00
Andrew Walbran
1d92abb1a7 Note lack of main function. 2023-03-20 14:26:57 +00:00
Andrew Walbran
120ef6331f Write welcome page for bare-metal Rust. 2023-03-20 14:26:57 +00:00
Andrew Walbran
d507096d31 Mention svd2rust. 2023-03-20 14:26:57 +00:00
Andrew Walbran
f8f6922b0c Add pages with PAC and HAL examples. 2023-03-20 14:26:57 +00:00
Andrew Walbran
780afddc11 Add example to turn on an LED. 2023-03-20 14:26:57 +00:00
Andrew Walbran
9068b63e76 Actually use panic_halt in example. 2023-03-20 14:26:57 +00:00
Andrew Walbran
d84c93010a no_std examples won't build in mdbook test. 2023-03-20 14:26:57 +00:00
Andrew Walbran
8e009b9674 Remove reference to panic-abort. 
It doesn't build with current rustc.
 2023-03-20 14:26:57 +00:00
Andrew Walbran
0a2263451d Add alloc example. 2023-03-20 14:26:57 +00:00
Andrew Walbran
2981d3856f Mention panic-abort and panic-halt crates. 2023-03-20 14:26:57 +00:00
Andrew Walbran
f71a86d942 Add minimal no_std example. 2023-03-20 14:26:57 +00:00
Andrew Walbran
27820629e2 Rename section to bare metal. 2023-03-20 14:26:57 +00:00
Andrew Walbran
51ccf44f52 Add initial outline for bare-metal Rust day. 2023-03-20 14:26:57 +00:00
Andrew Walbran
daf25d094b
Make Miri happy (#486) 
I think this is a better solution than #308. It fixes the Miri error, and mostly keeps the original intent of demonstrating how to use raw pointers.
 2023-03-15 23:18:12 +00:00
Andrew Walbran
7a22d5567a
Don't allocate in success case (#506) 
`format!` was being called (and allocating a string) even in the success case.
 2023-03-15 09:06:35 +01:00
Oliver Mannion
9ee562c267
Remove unnecessary Mutex::lock from shared state example (#499) 
It's not necessary to explicitly take the lock to print it.
 2023-03-12 10:48:52 +01:00
Charisee Chiw
59d3d7f625
Indent code in speaker notes (#476) 
* Indent code in speaker notes

#475

* Update stack.md

* Update destructuring-arrays.md

* Update hashmap.md

* Update traits.md
 2023-03-11 14:12:32 -08:00
Daniel Gorelik
368f3ba302
The code block at https://google.github.io/comprehensive-rust/testing/unit-tests.html probably should not be runnable (#498) 2023-03-11 10:12:37 +01:00
Dustin J. Mitchell
bfed596d28
Generalize the day-4 afternoon (#487) 
* Generalize the day-4 afternoon

This is in preparation for adding more options for this portion of the
course, and reflects an existing practice of substituting other
materials for this last half-day.

* address review comments
 2023-03-10 09:07:36 -05:00
MMINO
ff66258c50
Fix typo in borrowing.md in the Speaker's Notes (#490) 
the -> they
 2023-03-09 14:13:04 +00:00
Charisee Chiw
3242afae09
Create default.md (#370) 
* Create default.md

* Update SUMMARY.md

* Update SUMMARY.md

* Update default.md

* Update default.md

* Update default.md
 2023-03-07 17:11:43 +01:00
Martin Geisler
64340562ea
Add badges to README and welcome page (#481) 2023-03-07 12:45:00 +00:00
Martin Geisler
31500974e4
Add note about requesting a room with tables (#479) 
* Add note about requesting a room with tables

The course is built on the idea of using live-coding as much as possible. This means that it's important that there are desks in the classrooms — a traditional auditorium setup does not work well.
 2023-03-06 15:23:10 +01:00
JeongHyeon Lee
05eb17a6fe
Fix typo in string.md (#473) 2023-03-04 17:22:04 +01:00
Andrew Walbran
a78d58ba56
Add note about hygienic macros (#472) 
* Add note about hygienic macros

* Fix typo.

* Add link about macro hygiene.
 2023-03-03 12:19:52 +00:00
Martin Geisler
2de8d7cdbb
Simplify running the course slightly (#463) 
Thanks to many contributors, we now have lots of speaker notes.
 2023-03-02 09:13:49 +01:00
Charisee Chiw
c22b35e426
Remove silenced warnings in book-library exercise (#388) 
* Update book-library.md

* Update book-library.rs

* Apply suggestions from code review

Expanding the variable makes it ever-so-slightly easier to read.

---------

Co-authored-by: Martin Geisler <mgeisler@google.com>
 2023-02-28 17:53:02 -08:00
Martin Geisler
1feb94e02a
Take out unnecessary code from enum size slide (#309) 
The slide is way too large to comfortable use in a classroom. Instead
of printing six lines of output, the instructor should carefully walk
through the different examples. That way we can take the course
participants with us through the explanations instead of simply
showing them the end result.
 2023-02-27 17:42:46 +01:00
Adam MacBeth
b1b78a9672
Fix typo in string.md (#456) 
* Fix typo in string.md

* Update src/std/string.md

---------

Co-authored-by: Martin Geisler <martin@geisler.net>
 2023-02-27 13:37:08 +00:00
Steve Masterman
0562771ce0
Update variant-payloads.md (#459) 
Fix typo
 2023-02-27 13:19:32 +00:00
Charisee Chiw
e73b163d77
Add to speaker notes rc.md (#366) 
* Update rc.md

* Fix wording and formatting

* Update rc.md

---------

Co-authored-by: Andrew Walbran <qwandor@google.com>
 2023-02-27 02:05:01 +00:00
Adam MacBeth
4690f19e8c
Fix typo in drop.md (#457) 2023-02-26 22:04:39 +00:00
Andrew Jones
db7a6044b4
Remove extraneous trailing parenthesis (#453) 
The text currently looks like this:
> See the Rust Reference).

And should look like this:
> See the Rust Reference.

Closer #452
 2023-02-24 16:27:24 +01:00
Charisee Chiw
60aa747aca
Add Speaker notes string.md (#368) 
* Update string.md

* Update src/std/string.md

Co-authored-by: Martin Geisler <mgeisler@google.com>

* Update src/std/string.md

Co-authored-by: Martin Geisler <mgeisler@google.com>

* Update string.md

---------

Co-authored-by: Martin Geisler <mgeisler@google.com>
 2023-02-22 18:01:07 +00:00
Alexey Sokolov
e616f66593
Clarify box (#448) 2023-02-22 16:08:50 +01:00
Charisee Chiw
bb3b17b6bd
Additional speaker notes for variant payloads (#200) 
* Additional speaker notes for variant payloads

* Update variant-payloads.md

* Update variant-payloads.md
 2023-02-22 15:00:45 +00:00
Charisee Chiw
3f6bd6aa14
Speaker Notes for Field Shorthand (#198) 
* Speaker Notes for Field Shorthand

* Update field-shorthand.md
 2023-02-22 14:55:29 +00:00
Charisee Chiw
8ee637d886
Lecture notes for Destructing Arrays (#266) 
* Lecture notes for Destructing Arrays

* Update destructuring-arrays.md
 2023-02-22 13:41:12 +01:00
Adam MacBeth
9bb586689a
Minor grammar fixes to type-inference.md (#437) 2023-02-19 09:27:56 +01:00
Adam MacBeth
e6d6ee28fe
Update move-semantics.md (#438) 2023-02-19 09:27:41 +01:00
Adam MacBeth
aef4c3ca72
Update example.md (#441) 2023-02-19 04:53:11 +00:00
Adam MacBeth
9510e80165
Update receiver.md (#440) 2023-02-19 04:52:41 +00:00
Jiyong Park
92d00f2fd4
Fix typo: patten -> pattern (#430) 2023-02-17 18:34:35 +09:00
Jiyong Park
eb57ba9e51
Publish Korean translation (#428) 
* Publish Korean translation

* 한국어 -> 한국어 (Korean)

* Add translator names for the Korean translation
 2023-02-17 17:58:33 +09:00
Andrew Jones
9a4cda6f35
Fix references within options returned from Args (#427) 
This fixes #426
 2023-02-16 21:54:18 +00:00
Martin Geisler
bc2dbd0fd3
Add a page which mentions the translations (#424) 
This is to help people discover the language picker.
 2023-02-16 13:21:45 +01:00
gendx
29b6b90bfc
Add example where breaking UTF-8 encoding leads to a crash. (#387) 2023-02-16 03:19:44 +00:00
Marko Zagar
fe21b773e7
Day2: Afternoon - speaker note details and minor cosmetic changes. (#408) 
* A few speaker notes in Day2: Afternoon and minor cosmetic changes.

* Do not test filesystem example code block.
 2023-02-16 03:19:25 +00:00
Martin Geisler
f16b41f012
Further simplify Box diagrams (#409) 
* Further simplify `Box` diagrams

I think we can improve the drawing by simplifying them and making them
more symbolic. Followup to #374.

* Apply suggestions from code review
 2023-02-15 18:10:50 +00:00
Jan Wilken Dörrie
8e4bf245d3
Add Too Many Lists book to other resources (#410) 
As suggested by @mgeisler in https://news.ycombinator.com/item?id=34092980. Wording taken from https://github.com/rust-unofficial/awesome-rust#resources.
 2023-02-14 21:25:06 +00:00
Charisee Chiw
2436560e40
Let user know they can modify the tests, but do not need to. (#401) 2023-02-14 12:28:22 -08:00
Charisee Chiw
c06709838f
Update visibility.md (#403) 2023-02-14 12:24:32 -08:00
Charisee Chiw
cd79cc41a3
Remove code markers for compiler message (#402) 
Follow up on comment in merged PR #360, working on issue #274
 2023-02-14 20:22:49 +00:00
gendx
8dd5a78626
Clarify the Box layout diagrams. (#374) 2023-02-14 20:03:46 +01:00
Matt Smith
916c297d8c
Remove explicit typing in Mutex example (#405) 
Example contained unnecessary explicit type info for the vector in Mutex v. Rust will magically do the needful conversions for us. Code looks cleaner/simpler without the explicit typing.
 2023-02-14 18:40:22 +01:00
Charisee Chiw
2b1dc9ec66
Fix typo in args().next() (#400) 
* Fix typo in args().next()

Follow up on #367

* Update match-expressions.md
 2023-02-13 21:56:38 +00:00
Charisee Chiw
faaf2eacdc
Speaker Notes for hashmap.md (#295) 
* Update hashmap.md

* Update hashmap.md

* Update hashmap.md

* Update src/std/hashmap.md

Co-authored-by: gendx <gendx@users.noreply.github.com>

* Update hashmap.md

* Wording

---------

Co-authored-by: gendx <gendx@users.noreply.github.com>
Co-authored-by: Andrew Walbran <qwandor@google.com>
 2023-02-13 20:42:35 +00:00
Charisee Chiw
6f878dcf8f
Speaker Notes for tuple-structs (#197) 
* Speaker Notes for tuple-structs

* Update tuple-structs.md
 2023-02-13 16:31:15 +01:00
gendx
957f2a70f0
Add speaker notes for visibility. (#348) 2023-02-13 08:25:57 +00:00
Matt Smith
9fe0b68a2d
Fix an English grammatical typo (#386) 2023-02-10 15:53:27 +01:00
gendx
710fd526b4
Clarification in Trait Objects. (#379) 2023-02-09 21:51:08 +00:00
gendx
91eec89c52
Clarify that trait bounds give access to methods and add example of impl Trait. (#378) 2023-02-09 21:50:34 +00:00
gendx
f912825411
Add documentation links to the important traits. (#377) 
* Add documentation links to the important traits.

* Also add links in the sub-pages.
 2023-02-09 21:47:47 +00:00
gendx
fbb12161eb
Mention rc::Weak and add an example with a cycle in the speaker notes. (#375) 2023-02-09 21:46:40 +00:00
gendx
f9f04651ce
Add more example methods to Vec and HashMap. (#373) 2023-02-09 21:45:43 +00:00
Charisee Chiw
3a734230c9
Update visibility.md (#357) 2023-02-09 21:19:56 +00:00
Charisee Chiw
cf931075d5
Update destructuring-arrays.md (#369) 
* Update destructuring-arrays.md

* Update destructuring-arrays.md
 2023-02-09 13:17:33 -08:00
Charisee Chiw
6a1282c166
Update for-expressions.md (#359) 
* Update for-expressions.md

* Update for-expressions.md

* Update for-expressions.md

* Fix formatting.

---------

Co-authored-by: Andrew Walbran <qwandor@google.com>
 2023-02-09 21:17:15 +00:00
Charisee Chiw
65340c4ca1
Update match-expressions.md (#367) 
* Update match-expressions.md

* Apply suggestions from code review

Fine tuning the casing and explanations.

---------

Co-authored-by: Martin Geisler <mgeisler@google.com>
 2023-02-09 13:16:30 -08:00
Marko Zagar
36ce63cb10
Updates and minor fixes to Day 2: Morning (#372) 2023-02-09 21:15:47 +00:00
Charisee Chiw
e3b4b6a5c7
Update box.md (#363) 2023-02-09 20:55:19 +00:00
Charisee Chiw
736de71c7c
Update loop-expressions.md (#362) 
* Update loop-expressions.md

* Update loop-expressions.md

* Fix formatting.

---------

Co-authored-by: Andrew Walbran <qwandor@google.com>
 2023-02-09 20:52:37 +00:00
Charisee Chiw
1587d796cb
Update modules.md (#358) 
* Update modules.md

* Update modules.md

* Fix capitalisation and formatting.

---------

Co-authored-by: Andrew Walbran <qwandor@google.com>
 2023-02-09 20:50:43 +00:00
Charisee Chiw
426d7d91c2
Update points-polygons.md (#361) 2023-02-09 20:49:35 +00:00
Charisee Chiw
aa316544c3
Update box-recursive.md (#360) 2023-02-09 20:49:00 +00:00
Martin Geisler
c4bc10e31d
Inline variables printed with println! and friends (#315) 
The course follows the style of inlining variable names where possible
in `println!` statements.
 2023-02-09 07:48:18 +01:00
gendx
ce19841249
Add highly-unsafe speaker notes to inspect the memory layout of string. (#341) 2023-02-09 07:47:15 +01:00
Charisee Chiw
1835896e58
Speaker notes for destructuring-structs.md (#265) 
* Update destructuring-structs.md

* Update destructuring-structs.md
 2023-02-07 07:42:57 +00:00