在 Rust 库中仅公开泛型私有类型的具体变体

Question

我有一个 Rust 库 crate，其代码结构如下：

pub struct Foo<X> {
    x: X,
}

pub fn foo() -> Foo<u32> {
    // ...
}

// + private functions

特别是，虽然 lib 在内部使用 Foo 的不同变体（例如 Foo<u8>、Foo<u32>），但 Foo 仅作为 Foo<u32> 出现在 lib 的公共 API 中。

像我目前所做的那样公开通用Foo 会使lib 的公共API 及其文档变得不必要地复杂：用户永远不会从不是Foo<u32> 的库中获得Foo。因此，我想以某种方式只公开和公开记录Foo<u32>（最好使用不同的非通用名称，例如Bar）并将Foo设为私有。

我尝试过使用类型别名 (type Bar = Foo<u32>)，但似乎它们会自动扩展为 cargo doc（而且它们似乎也没有单独的可见性）。

我可能会复制Foo<X> 的定义并将其命名为Bar，然后为Bar 实现类似From<Foo<u32>> 的东西。但是，我对Foo<X> 的实际定义相当复杂，所以我想避免这种情况。

还有其他方法可以实现我的目标吗？

Answer 1

您可以按如下方式从父模块公开类型：

mod prelude {
    mod foo_mod {
        pub struct Foo<X> {
            x: X,
        }

        impl Foo<u32> {
            pub fn foo() -> u32 {
                32
            }
        }

        impl Foo<u8> {
            pub fn foo() -> u8 {
                8
            }
        }
    }

    pub type FooBar = foo_mod::Foo<u32>;
}


fn main() {
    use prelude::FooBar; // we can use this
    use prelude::foo_mod::Foo; // we cannot use this
}

Playground

Answer 2

我不建议 Netwave 把戏，它欺骗了 Rust 的公私规则，我认为这样的代码不应该编译。这会将Foo 暴露给用户，因此实际上Foo 是完全公开的，对Foo 的任何更改都是重大更改。

根据您的问题描述：

特别是，虽然 lib 在内部使用不同的 Foo 变体（例如 Foo、Foo），但 Foo 仅作为 Foo 出现在 lib 的公共 API 中。

解决方案是做一个真正的包装器：

pub struct FooBar {
  foo: Foo<u32>,
}

impl FooBar {
  pub fn some_pub_fct();
}

正如你所说，这是你应该做的，因为用户不需要泛型，所以你想要的是隐藏用户的实现细节。这比泄露私人项目的 netwave 技巧要好得多。这种方式很清楚，更改FooBar 是一项重大更改，因为它被认为是公共项目。您可以随意更改Foo。用户赢了，你就赢了。