From 957f2a70f0d455819f5a7884cd429e8c75e346e3 Mon Sep 17 00:00:00 2001 From: gendx Date: Mon, 13 Feb 2023 08:25:57 +0000 Subject: [PATCH] Add speaker notes for visibility. (#348) --- src/modules/visibility.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/src/modules/visibility.md b/src/modules/visibility.md index d17356c5..48dea5ec 100644 --- a/src/modules/visibility.md +++ b/src/modules/visibility.md @@ -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(); } ``` +
- -* 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). +