Rust の #[derive] マクロ

1. #[derive] マクロとは何か

#[derive(TraitName)] は 属性マクロ の一種で、struct / enum / union の定義に付けると コンパイラがその型に対する トレイト実装 (impl ブロック) を自動生成してくれます。

// これだけ書けば…
#[derive(Debug, Clone)]
pub struct Point { x: f64, y: f64 }

// コンパイラが内部で impl を生成してくれる（次のセクションで詳述）

Rust における derive は 手続きマクロ (procedural macro) の一形態です。 標準ライブラリが提供するものはコンパイラに組み込まれており、 外部クレート（serde など）が提供するものは proc-macro クレートとして実装されています。

2. 展開図: Before / After

2-1. あなたが書くコード

#[derive(Debug, Clone)]
pub struct TsmHeader {
    pub width:  u16,
    pub height: u16,
    pub frames: u32,
    pub fps:    f32,
}

2-2. コンパイラが内部で生成する同等のコード

impl std::fmt::Debug for TsmHeader {
    fn fmt(
        &self,
        f: &mut std::fmt::Formatter<'_>
    ) -> std::fmt::Result {
        f.debug_struct("TsmHeader")
            .field("width",  &self.width)
            .field("height", &self.height)
            .field("frames", &self.frames)
            .field("fps",    &self.fps)
            .finish()
    }
}

impl std::clone::Clone for TsmHeader {
    fn clone(&self) -> Self {
        TsmHeader {
            width:  self.width.clone(),
            height: self.height.clone(),
            frames: self.frames.clone(),
            fps:    self.fps.clone(),
        }
    }
}

derive の本質: 各フィールドに対して同じトレイトが実装されていれば、 struct 全体への実装を「フィールド分繰り返す」コードをコンパイラが生成します。

3. 標準ライブラリが提供する derive 一覧

4. 依存関係グラフ

derive には「これを付けるにはあれも必要」という依存関係があります。 矢印は「必要とする」方向です。

よくある「正しい組み合わせ」

// 整数値 newtype（完全体）
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct FrameIndex(pub usize);

// ヒープを含む型（Copy 不可）
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct Filename(pub String);

// f64 を含む型（Eq/Hash/Ord は不可）
#[derive(Debug, Clone, Copy, PartialEq, PartialOrd)]
pub struct TimeMs(pub f64);

5. derive できない場合の対処

5-1. なぜ derive できないか

derive は「全フィールドが同じトレイトを実装していれば struct にも実装できる」という単純な規則で動きます。 以下のケースでは derive が使えません:

5-2. 手動 impl の例

// Array3<i16> は PartialEq を持たないため、データ次元だけを比較する例
use ndarray::Array3;

pub struct FramesData {
    pub data: Array3<i16>,
}

impl PartialEq for FramesData {
    fn eq(&self, other: &Self) -> bool {
        // shape だけ比較（実データは高価なので比較しない設計）
        self.data.shape() == other.data.shape()
    }
}

5-3. 条件付き bound の例

// derive が生成する bound が過剰な場合の回避策
pub struct Wrapper<T> {
    inner: T,
    cached: Option<String>,
}

// derive(Clone) は T: Clone を要求するが、cached は独立して Clone できる
// 通常はこれで OK（T: Clone がほぼ常に成立するため）
#[derive(Clone)]
pub struct Wrapper<T: Clone> { ... }

// または T に Clone bound なしで手動 impl
impl<T: Clone> Clone for Wrapper<T> {
    fn clone(&self) -> Self {
        Wrapper { inner: self.inner.clone(), cached: self.cached.clone() }
    }
}

6. 外部クレートが提供する derive

外部クレートも proc-macro クレートとして derive を提供できます。 Cargo.toml に依存を追加すれば、標準の derive と同じ文法で使えます。

serde の例

use serde::{Serialize, Deserialize};

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TsmHeader {
    pub width:  u16,
    pub height: u16,
    pub frames: u32,
    pub fps:    f32,
}

// JSON に変換
let header = TsmHeader { width: 128, height: 128, frames: 64, fps: 100.0 };
let json = serde_json::to_string(&header)?;
// → {"width":128,"height":128,"frames":64,"fps":100.0}

binrw の例（TSM ヘッダパース）

use binrw::BinRead;

#[derive(BinRead, Debug, Clone)]
#[br(little)]  // リトルエンディアン
pub struct TsmHeader {
    pub width:  u16,
    pub height: u16,
    #[br(pad_before = 8)]  // 8 バイトスキップ
    pub frames: u32,
    pub fps:    f32,
}

// ファイルから直接パース
let header: TsmHeader = cursor.read_le()?;

7. 判断フロー: derive で済むか手動 impl か

8. scandata 文脈への応用

8-1. TsmHeader に #[derive(Debug, Clone)] を付ける意味

TSM ファイルの FITS ヘッダをパースした結果を格納する TsmHeader は、 以下の理由で Debug と Clone が特に重要です:

• Debug: パース結果を println!("{:#?}", header) で即確認できる。 开発中に「ヘッダが正しく読めているか」を printf デバッグする手間をなくす。
• Clone: TsmHeader はファイル I/O 後に Repository と ValueObject の両方に渡す可能性があるため、 .clone() で複製できると設計が柔軟になる。

// TSM ヘッダは複数フィールドを持つそれなりの大きさの struct
#[derive(Debug, Clone)]  // Copy は付けない
pub struct TsmHeader {
    pub width:      u16,
    pub height:     u16,
    pub frames:     u32,
    pub fps:        f32,
    pub channel:    u8,
    // ... さらに FITS ヘッダのフィールドが続く
}

// 整数ベース: 軽量なので Copy も付ける
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct Channel(pub u8);

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct FrameIndex(pub usize);

// String ベース: Copy 不可
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct Filename(pub String);

// serde + binrw を組み合わせる場合
#[derive(Debug, Clone, BinRead, Serialize, Deserialize)]
#[br(little)]
pub struct TsmHeader { ... }

#[derive(Clone)]          // im::HashMap に入れるために必須
pub enum ValueObj {
    Frames(FramesData),
    Image(ImageData),
}

#[derive(Clone)]
pub struct FramesData {
    pub data: std::sync::Arc<ndarray::Array3<i16>>,  // Clone = Rc++
    pub tag:  DataTag,
}