rust/comprehensive-rust
1
0
Fork 0
mirror of https://github.com/google/comprehensive-rust.git synced 2025-04-03 18:15:31 +02:00
Code Issues Releases Activity

Add speaker notes for visibility. (#348)

Browse Source
This commit is contained in:
gendx 2023-02-13 08:25:57 +00:00 committed by GitHub
parent 9fe0b68a2d
commit 957f2a70f0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/modules/visibility.md
View File

@ -4,6 +4,8 @@ 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
descendants of `foo`.
```rust,editable
mod outer {
@ -31,8 +33,16 @@ fn main() {
outer::public();
}
```
<details>
* Use the `pub` keyword to make mods public.
* Use the `pub` keyword to make mods public.
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).
</details>