Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Управление областью видимости и приватностью с помощью модулей

В этом разделе мы поговорим о модулях и других частях системы модулей, а именно о путях (paths), которые позволяют именовать элементы; ключевом слове use, которое вводит путь в область видимости; и ключевом слове pub, чтобы делать элементы публичными. Мы также обсудим ключевое слово as, внешние пакеты и оператор glob.

Шпаргалка по модулям

Прежде чем мы перейдём к деталям модулей и путей, здесь мы приводим краткую справку о том, как модули, пути, ключевое слово use и ключевое слово pub работают в компиляторе и как большинство разработчиков организуют свой код. На протяжении этой главы мы будем разбирать примеры каждого из этих правил, но это отличное место, к которому можно обращаться как к напоминанию о том, как работают модули.

  • Начинайте с корня крейта: При компиляции крейта компилятор сначала ищет в файле корня крейта (обычно src/lib.rs для библиотечного крейта и src/main.rs для бинарного крейта) код для компиляции.
  • Объявление модулей: В файле корня крейта можно объявлять новые модули; скажем, вы объявляете модуль «garden» с помощью mod garden;. Компилятор будет искать код модуля в следующих местах:
    • Встроенно, внутри фигурных скобок, заменяющих точку с запятой после mod garden
    • В файле src/garden.rs
    • В файле src/garden/mod.rs
  • Объявление подмодулей: В любом файле, кроме корня крейта, можно объявлять подмодули. Например, вы можете объявить mod vegetables; в src/garden.rs. Компилятор будет искать код подмодуля в директории, названной по имени родительского модуля, в следующих местах:
    • Встроенно, непосредственно после mod vegetables, внутри фигурных скобок вместо точки с запятой
    • В файле src/garden/vegetables.rs
    • В файле src/garden/vegetables/mod.rs
  • Пути к коду в модулях: Как только модуль становится частью вашего крейта, вы можете обращаться к коду в этом модуле из любого другого места того же крейта, если это позволяют правила приватности, используя путь к коду. Например, тип Asparagus в модуле garden vegetables будет найден по пути crate::garden::vegetables::Asparagus.
  • Приватное против публичного: Код внутри модуля по умолчанию приватный по отношению к его родительским модулям. Чтобы сделать модуль публичным, объявите его с помощью pub mod вместо mod. Чтобы сделать элементы внутри публичного модуля также публичными, используйте pub перед их объявлениями.
  • Ключевое слово use: В пределах области видимости ключевое слово use создаёт сокращения для элементов, чтобы уменьшить повторение длинных путей. В любой области видимости, которая может ссылаться на crate::garden::vegetables::Asparagus, можно создать сокращение с помощью use crate::garden::vegetables::Asparagus;, и с этого момента вам нужно будет написать только Asparagus, чтобы использовать этот тип в области видимости.

Здесь мы создаём бинарный крейт под названием backyard, который иллюстрирует эти правила. Директория крейта, также называемая backyard, содержит следующие файлы и директории:

backyard
├── Cargo.lock
├── Cargo.toml
└── src
    ├── garden
    │   └── vegetables.rs
    ├── garden.rs
    └── main.rs

Файл корня крейта в этом случае — src/main.rs, и он содержит:

Имя файла: src/main.rs
use crate::garden::vegetables::Asparagus;

pub mod garden;

fn main() {
    let plant = Asparagus {};
    println!("I'm growing {plant:?}!");
}

Строка pub mod garden; сообщает компилятору включить код, который он находит в src/garden.rs, а именно:

Имя файла: src/garden.rs
pub mod vegetables;

Здесь pub mod vegetables; означает, что код в src/garden/vegetables.rs также включён. Этот код:

#[derive(Debug)]
pub struct Asparagus {}

Теперь давайте углубимся в детали этих правил и продемонстрируем их в действии!

Модули позволяют организовывать код внутри крейта для читаемости и лёгкого повторного использования. Модули также позволяют нам контролировать приватность элементов, поскольку код внутри модуля по умолчанию приватный. Приватные элементы — это внутренние детали реализации, недоступные для внешнего использования. Мы можем по своему выбору делать модули и элементы внутри них публичными, что делает их доступными, позволяя внешнему коду использовать их и зависеть от них.

В качестве примера напишем библиотечный крейт, который предоставляет функциональность ресторана. Мы определим сигнатуры функций, но оставим их тела пустыми, чтобы сосредоточиться на организации кода, а не на реализации ресторана.

В ресторанной индустрии некоторые части ресторана называются «передней частью дома» (front of house), а другие — «задней частью дома» (back of house). Передняя часть дома — это место, где находятся клиенты; она включает места, где хостес рассаживают клиентов, официанты принимают заказы и оплату, а бармены готовят напитки. Задняя часть дома — это место, где повара и кулинары работают на кухне, посудомойщики убирают, а менеджеры выполняют административную работу.

Чтобы структурировать наш крейт таким образом, мы можем организовать его функции во вложенные модули. Создайте новую библиотеку под названием restaurant, выполнив cargo new restaurant --lib. Затем введите код из листинга 7-1 в src/lib.rs, чтобы определить некоторые модули и сигнатуры функций; этот код — часть передней части дома.

Имя файла: src/lib.rs
mod front_of_house {
    mod hosting {
        fn add_to_waitlist() {}

        fn seat_at_table() {}
    }

    mod serving {
        fn take_order() {}

        fn serve_order() {}

        fn take_payment() {}
    }
}
Листинг 7-1: Модуль front_of_house, содержащий другие модули, которые затем содержат функции

Мы определяем модуль ключевым словом mod, за которым следует имя модуля (в данном случае front_of_house). Тело модуля затем помещается внутри фигурных скобок. Внутри модулей можно размещать другие модули, как в этом случае с модулями hosting и serving. Модули также могут содержать определения других элементов, таких как структуры, перечисления, константы, трейты и, как в листинге 7-1, функции.

Используя модули, мы можем группировать связанные определения вместе и давать имена тому, почему они связаны. Программисты, использующие этот код, могут перемещаться по коду на основе групп, а не читать все определения, что упрощает поиск определений, относящихся к ним. Программисты, добавляющие новую функциональность в этот код, знали бы, куда поместить код, чтобы поддерживать организованность программы.

Ранее мы упоминали, что src/main.rs и src/lib.rs называются корнями крейта. Причина их названия в том, что содержимое любого из этих двух файлов образует модуль под названием crate в корне структуры модулей крейта, известной как дерево модулей.

Листинг 7-2 показывает дерево модулей для структуры из листинга 7-1.

crate
 └── front_of_house
     ├── hosting
     │   ├── add_to_waitlist
     │   └── seat_at_table
     └── serving
         ├── take_order
         ├── serve_order
         └── take_payment
Листинг 7-2: Дерево модулей для кода из листинга 7-1

Это дерево показывает, как некоторые модули вложены в другие модули; например, hosting вложен в front_of_house. Дерево также показывает, что некоторые модули являются соседями (siblings), то есть они определены в одном модуле; hosting и serving — соседи, определённые внутри front_of_house. Если модуль A содержится внутри модуля B, мы говорим, что модуль A — потомок модуля B, а модуль B — родитель модуля A. Обратите внимание, что всё дерево модулей имеет корень под неявным модулем под названием crate.

Дерево модулей может напомнить вам дерево директорий файловой системы на вашем компьютере; это очень уместное сравнение! Точно так же, как директории в файловой системе, вы используете модули для организации кода. И точно так же, как файлы в директории, нам нужен способ находить наши модули.