rust - 如果从模块导出的项目暴露了内部代码，如何组织内部代码？

Question

我正在开发一个 Rust 模块，该模块具有较小的外部接口(interface)，但其内部实现又大又复杂。

是否有一种明智的方法可以避免使用包含模块所有代码的巨大文件，同时仍然向外部模块使用者公开一个小接口(interface)？

据我所知，Rust 不允许您对同一模块使用多个文件，例如 Go 允许使用包目录。 Rust 模块定义在一个目录中并不重要，它仍然需要一个文件。

这样，为了拆分代码，您必须使用子模块来表示您想要拆分的子类型或实现细节。据我所知，对于编译的代码来说应该没有多大关系，模块组织的所有开销都被删除了。

但是存在一个设计问题，如果我将内容拆分为模块，那么这些内容将需要导出内容，以便我可以从其他模块中使用它们...但是这些“导出的内部结构”也可以由外部使用消费者，对吗？有没有办法避免暴露这些内部接口(interface)？

Answer 1

But there is a design problem, if I split things up in modules, those will need to export things so that I can used them from my other modules... but then those "exported internals" can ALSO be used by external consumers, right?

不，他们不能。

在子模块中公开符号只会使其对其直接父模块可用。然后，该父模块必须通过 pub use 重新导出该符号，以获得“冒泡”的可见性。

mod foo {
    mod bar {
        pub fn visible_in_foo() {}
        pub fn visible_in_root() {}
        fn private() {}
    }
    
    // Re-export to make visible at the next outer level
    pub use bar::visible_in_root;

    pub fn foo() {
        // We are in the immediate parent, so both `pub` functions are visible
        bar::visible_in_foo();
        bar::visible_in_root();
        // bar::private(); - Won't compile
    }
}

// Make it public to consumers of the library, aka. external API
pub use foo::foo;

fn main() {
    // Notice that it's just `foo`. Not `foo::bar` or `bar`.
    // Re-exporting makes the symbol a part of module `foo`.
    foo::visible_in_root();

    // foo::visible_in_foo(); - Won't compile

    // `foo::foo` does have access to the inner module, though,
    // so we can call `foo::bar::visible_in_foo` indirectly here.
    foo::foo();
}

此外，您可以将符号标记为 pub(crate)，其工作方式类似于 pub，只不过它可以防止符号在 crate 之外公开，即使它是由其所有父模块重新导出。

进一步阅读:

• The Rust Programming Language - Defining Modules to Control Scope and Privacy
• The Rust Reference - Visibility and Privacy