rust-ndarrayのRawDataトレイトの__private_

rust_ndarrayのRawDataに__private__が実装されています。これが実装されている意味がわからないため質問させていただきます。__private__はマクロで実装されており、中身は、private.rsに実装されています。中身としては、PrivateMarkerを戻すものとなっています。この関数は、宣言されてるのみで他で使われていないように見えます。この関数が実装されている意味を教えていただきたいです。

行動規範の内容に同意します

回答1件

ベストアンサー

この関数が実装されている意味を教えていただきたいです。

その意味（目的）はprivate.rsのコメントに書かれているのですが、ndarrayクレート外に公開しているRawDataのようなトレイトを、ndarrayのユーザーが定義した型にimplされるのを禁止するためです。

RawDataトレイトはpublicメソッドのトレイト境界として使われているので、publicトレイトでなければなりません。その一方でユーザーにはimplさせたくありません。現時点のRust（1.55）ではそれを直接実現する方法は用意されていないため、以下のような裏技のような方法（？）で実現しています。

privateなモジュールprivateを定義する。

privateモジュール内に以下を定義する。

publicな構造体PrivateMarker。この構造体にはprivateモジュールと、ndarrayクレートのルートモジュール（lib.rs）からしかアクセスできない
private_decl!マクロとprivate_impl!マクロ。これらのマクロはndarrayクレート内からしかアクセスできない

RawDataのようにpublicだかユーザーにはimplさせたくないトレイトでは以下のようにする。

private_decl!マクロで以下のトレイトメソッドを定義する
fn __private__(&self) -> crate::private::PrivateMarker
ndarrayクレート外からはPrivateMarkerにアクセスできないので__private__メソッドは実装できない。つまりクレート外でこのトレイトをimplすることはできなくなる

ndarrayクレート内の型にRawDataのようなトレイトをimplするには以下のようにする。

private_impl!マクロを使って__private__メソッドを実装する

この関数は、宣言されてるのみで他で使われていないように見えます。

ndarrayクレート内ではprivate_impl!マクロによって使われています（実装されています）

例：RawViewRepr（src/data_traits.rs）

rust
1unsafe impl<A> RawData for RawViewRepr<*const A> {
2    ...
3
4    private_impl! {}
5}

これは、以下のコードに展開されます。

rust
1unsafe impl<A> RawData for RawViewRepr<*const A> {
2    ...
3
4    #[doc(hidden)]
5    fn __private__(&self) -> crate::private::PrivateMarker {
6        crate::private::PrivateMarker
7    }
8}