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

Разделение модулей на разные файлы

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

Например, начнём с кода из листинга 7-17, в котором было несколько модулей ресторана. Мы извлечём модули в файлы вместо того, чтобы определять все модули в файле корня крейта. В этом случае файл корня крейта — src/lib.rs, но эта процедура также работает с бинарными крейтами, чей файл корня крейта — src/main.rs.

Сначала извлечём модуль front_of_house в его собственный файл. Удалим код внутри фигурных скобок модуля front_of_house, оставив только объявление mod front_of_house;, так что src/lib.rs содержит код, показанный в листинге 7-21. Обратите внимание, что это не скомпилируется, пока мы не создадим файл src/front_of_house.rs из листинга 7-22.

Имя файла: src/lib.rs
mod front_of_house;

pub use crate::front_of_house::hosting;

pub fn eat_at_restaurant() {
    hosting::add_to_waitlist();
}
Листинг 7-21: Объявление модуля front_of_house, тело которого будет в src/front_of_house.rs

Затем поместим код, который был в фигурных скобках, в новый файл с именем src/front_of_house.rs, как показано в листинге 7-22. Компилятор знает, что нужно искать в этом файле, потому что он встретил объявление модуля в корне крейта с именем front_of_house.

Имя файла: src/front_of_house.rs
pub mod hosting {
    pub fn add_to_waitlist() {}
}
Листинг 7-22: Определения внутри модуля front_of_house в src/front_of_house.rs

Обратите внимание, что вам нужно загрузить файл с помощью объявления mod только один раз в вашем дереве модулей. Как только компилятор знает, что файл является частью проекта (и знает, где в дереве модулей находится код, потому что вы поместили туда оператор mod), другие файлы в вашем проекте должны ссылаться на код загруженного файла с помощью пути к тому месту, где он был объявлен, как описано в разделе «Пути для ссылки на элемент в дереве модулей». Иными словами, mod — это не операция «include», которую вы могли видеть в других языках программирования.

Затем мы извлечём модуль hosting в его собственный файл. Процесс немного отличается, потому что hosting — это дочерний модуль front_of_house, а не корневого модуля. Мы поместим файл для hosting в новую директорию, которая будет названа по его предкам в дереве модулей, в данном случае src/front_of_house.

Чтобы начать перемещение hosting, мы изменим src/front_of_house.rs, чтобы он содержал только объявление модуля hosting:

Имя файла: src/front_of_house.rs
pub mod hosting;

Затем мы создадим директорию src/front_of_house и файл hosting.rs, чтобы содержать определения, сделанные в модуле hosting:

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

Если бы мы вместо этого поместили hosting.rs в директорию src, компилятор ожидал бы, что код hosting.rs будет в модуле hosting, объявленном в корне крейта, а не объявленном как потомок модуля front_of_house. Правила компилятора о том, в каких файлах искать код каких модулей, означают, что директории и файлы более точно соответствуют дереву модулей.

Альтернативные пути к файлам

До сих пор мы рассматривали наиболее идиоматичные пути к файлам, которые использует компилятор Rust, но Rust также поддерживает более старый стиль пути к файлам. Для модуля с именем front_of_house, объявленного в корне крейта, компилятор будет искать код модуля в:

  • src/front_of_house.rs (то, что мы рассмотрели)
  • src/front_of_house/mod.rs (старый стиль, всё ещё поддерживаемый путь)

Для модуля с именем hosting, который является подмодулем front_of_house, компилятор будет искать код модуля в:

  • src/front_of_house/hosting.rs (то, что мы рассмотрели)
  • src/front_of_house/hosting/mod.rs (старый стиль, всё ещё поддерживаемый путь)

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

Главный недостаток стиля, использующего файлы с именем mod.rs, заключается в том, что в вашем проекте может оказаться много файлов с именем mod.rs, что может запутать, когда они открыты одновременно в вашем редакторе.

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

Обратите внимание, что оператор pub use crate::front_of_house::hosting в src/lib.rs также не изменился, и use не влияет на то, какие файлы компилируются как часть крейта. Ключевое слово mod объявляет модули, и Rust ищет в файле с тем же именем, что и модуль, код, который идёт в этот модуль.

Итоги

Rust позволяет разделить пакет на несколько крейтов, а крейт — на модули, чтобы вы могли ссылаться на элементы, определённые в одном модуле, из другого модуля. Вы можете делать это, указывая абсолютные или относительные пути. Эти пути можно ввести в область видимости с помощью оператора use, чтобы использовать более короткий путь для множественного использования элемента в этой области. Код модуля по умолчанию приватный, но вы можете сделать определения публичными, добавив ключевое слово pub.

В следующей главе мы рассмотрим некоторые структуры данных-коллекций в стандартной библиотеке, которые вы можете использовать в вашем аккуратно организованном коде.