Skip to content

Commit

Permalink
Clarify completion condition for elevator exercise (#1574)
Browse files Browse the repository at this point in the history
Addresses the first part of #1565.
  • Loading branch information
djmitche committed Dec 11, 2023
1 parent f04e277 commit e765159
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 4 deletions.
15 changes: 11 additions & 4 deletions src/user-defined-types/exercise.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,17 @@ We will create a data structure to represent an event in an elevator control
system. It is up to you to define the types and functions to construct various
events. Use `#[derive(Debug)]` to allow the types to be formatted with `{:?}`.

```rust,compile_fail
This exercise only requires creating and populating data structures so that
`main` runs without errors. The next part of the course will cover getting data
out of these structures.

```rust,should_panic
{{#include exercise.rs:event}}
// TODO: add required variants
}
{{#include exercise.rs:direction}}
{{#include exercise.rs:car_arrived}}
todo!()
}
Expand All @@ -31,6 +41,3 @@ events. Use `#[derive(Debug)]` to allow the types to be formatted with `{:?}`.
{{#include exercise.rs:main}}
```

This exercise only requires creating data structures. The next part of the
course will cover getting data out of these structures.
4 changes: 4 additions & 0 deletions src/user-defined-types/exercise.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,11 @@
#![allow(dead_code)]

// ANCHOR: solution
// ANCHOR: event
#[derive(Debug)]
/// An event in the elevator system that the controller must react to.
enum Event {
// ANCHOR_END: event
/// A button was pressed.
ButtonPressed(Button),

Expand All @@ -34,12 +36,14 @@ enum Event {
/// A floor is represented as an integer.
type Floor = i32;

// ANCHOR: direction
/// A direction of travel.
#[derive(Debug)]
enum Direction {
Up,
Down,
}
// ANCHOR_END: direction

/// A user-accessible button.
#[derive(Debug)]
Expand Down

0 comments on commit e765159

Please sign in to comment.