模块

语法
模块 :
      unsafe? mod 标识符 ;
   | unsafe? mod 标识符 {
        内部属性*
        条目*
      }

模块是零个或多个条目的容器。

模块条目是一个模块,用花括号包围,已命名,并以关键字 mod 为前缀。模块条目将一个新的、已命名的模块引入到构成 crate 的模块树中。

模块可以任意嵌套。

模块示例

#![allow(unused)]
fn main() {
mod math {
    type Complex = (f64, f64);
    fn sin(f: f64) -> f64 {
        /* ... */
      unimplemented!();
    }
    fn cos(f: f64) -> f64 {
        /* ... */
      unimplemented!();
    }
    fn tan(f: f64) -> f64 {
        /* ... */
      unimplemented!();
    }
}
}

模块在它们所在的模块或块的类型命名空间中定义。

在同一个模块的同一命名空间中定义多个同名条目是错误的。有关限制和阴影行为的更多详细信息,请参阅作用域章节

unsafe 关键字在语法上允许出现在 mod 关键字之前,但在语义层面被拒绝。这允许宏使用该语法并利用 unsafe 关键字,然后在标记流中删除它。

模块源文件名

没有主体的模块从外部文件加载。当模块没有 path 属性时,文件的路径会镜像逻辑模块路径

祖先模块路径组件是目录,模块的内容位于以模块名称加上 .rs 扩展名的文件中。例如,以下模块结构可以具有以下相应的filesystem结构

模块路径文件系统路径文件内容
cratelib.rsmod util;
crate::utilutil.rsmod config;
crate::util::configutil/config.rs

模块文件名也可以是模块名称作为目录,内容位于该目录中名为 mod.rs 的文件中。上面的示例也可以用 crate::util 的内容在名为 util/mod.rs 的文件中表示。不允许同时存在 util.rsutil/mod.rs

注意: 在 rustc 1.30 之前,使用 mod.rs 文件是加载带有嵌套子模块的模块的方式。建议使用新的命名约定,因为它更一致,并避免在一个项目中出现许多名为 mod.rs 的文件。

path 属性

用于加载外部文件模块的目录和文件可以使用 path 属性来影响。

对于不在内联模块块中的模块的 path 属性,文件路径相对于源文件所在的目录。例如,以下代码片段将根据其所在位置使用显示的路径

#[path = "foo.rs"]
mod c;
源文件c 的文件位置c 的模块路径
src/a/b.rssrc/a/foo.rscrate::a::b::c
src/a/mod.rssrc/a/foo.rscrate::a::c

对于内联模块块内的 path 属性,文件路径的相对位置取决于 path 属性所在的源文件类型。“mod-rs”源文件是根模块(例如 lib.rsmain.rs)和文件名为 mod.rs 的模块。“non-mod-rs”源文件是所有其他模块文件。mod-rs 文件中内联模块块内的 path 属性的路径相对于 mod-rs 文件的目录,包括内联模块组件作为目录。对于 non-mod-rs 文件,它是相同的,只是路径以 non-mod-rs 模块名称的目录开头。例如,以下代码片段将根据其所在位置使用显示的路径

mod inline {
    #[path = "other.rs"]
    mod inner;
}
源文件inner 的文件位置inner 的模块路径
src/a/b.rssrc/a/b/inline/other.rscrate::a::b::inline::inner
src/a/mod.rssrc/a/inline/other.rscrate::a::inline::inner

结合内联模块和嵌套模块上的 path 属性的上述规则的示例(适用于 mod-rs 和 non-mod-rs 文件)

#[path = "thread_files"]
mod thread {
    // Load the `local_data` module from `thread_files/tls.rs` relative to
    // this source file's directory.
    #[path = "tls.rs"]
    mod local_data;
}

模块上的属性

模块像所有条目一样,接受外部属性。它们也接受内部属性:对于带有主体的模块,在 { 之后,或者在源文件的开头,在可选的 BOM 和 shebang 之后。

在模块上具有内置含义的属性是 cfgdeprecateddoclint 检查属性pathno_implicit_prelude。模块也接受宏属性。