Skip to content

std-traits: add explanatory commentary to solution #3060

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mgeisler wants to merge 1 commit into
base: main
Choose a base branch
from
Open

std-traits: add explanatory commentary to solution #3060

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions src/std-traits/solution.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,21 @@
```rust,editable
{{#include exercise.rs:solution}}
```

- **Wrapper Pattern:** `RotDecoder` wraps another reader `R`.
- **Delegation:** The `read` implementation first calls `self.input.read(buf)`
to read data into the buffer. This is essential; we need raw data before we
can transform it.
- **In-place Mutation:** After reading, the code iterates over the populated
part of the buffer (`buf[..size]`) and modifies the bytes in place.
- **Error Handling:** The `?` operator is used to check the result of
`self.input.read`. If it fails, the error is immediately returned.

<details>

- Mention that `rot` is a simple Caesar cipher.
- Chaining two ROT13 instances (rotations by 13) results in a rotation by 26,
which wraps around to the original text (for English alphabets). This property
is why ROT13 is its own inverse.

</details>