関連関数とメソッド

関数には特定の型に紐づいたものがあります。これには関連関数とメソッドの2つの形式があります。メソッドは特定のインスタンスに関連付けて呼ばれる関数であるのに対し、関連関数は型全体に対して定義される関数です。

struct Point {
    x: f64,
    y: f64,
}

// 実装のためのブロック。`Point`の持つ関連関数とメソッドを全て定義します。
impl Point {
    // これは特定の型（すなわち Point）に関連した関数なので関連関数
    //
    // 関連関数はインスタンスからでなく呼び出すことができます。
    // 以下のようにコンストラクタとしてよく使用されます。
    fn origin() -> Point {
        Point { x: 0.0, y: 0.0 }
    }

    // 引数を2つ取る関連関数
    fn new(x: f64, y: f64) -> Point {
        Point { x: x, y: y }
    }
}

struct Rectangle {
    p1: Point,
    p2: Point,
}

impl Rectangle {
    // こちらはメソッド。`&self`は`self: &Self`の糖衣構文。
    // `Self`は呼び出し元オブジェクトの型。この場合は`Rectangle`。
    fn area(&self) -> f64 {
        // `self`はドット演算子によって構造体のフィールドを参照できます。
        let Point { x: x1, y: y1 } = self.p1;
        let Point { x: x2, y: y2 } = self.p2;

        // `abs`は`f64`のメソッドで、呼び出し元の値の絶対値を返します。
        ((x1 - x2) * (y1 - y2)).abs()
    }

    fn perimeter(&self) -> f64 {
        let Point { x: x1, y: y1 } = self.p1;
        let Point { x: x2, y: y2 } = self.p2;

        2.0 * ((x1 - x2).abs() + (y1 - y2).abs())
    }

    // このメソッドは呼び出し元オブジェクトがミュータブルであることを
    // 必要とします。`&mut self`は`self: &mut Self`の糖衣構文です。
    fn translate(&mut self, x: f64, y: f64) {
        self.p1.x += x;
        self.p2.x += x;

        self.p1.y += y;
        self.p2.y += y;
    }
}

// `Pair`はヒープ上の整数を2つ保持します。
struct Pair(Box<i32>, Box<i32>);

impl Pair {
    // このメソッドは呼び出し元オブジェクトを「消費」します。
    // `self`は`self: Self`の糖衣構文です。
    fn destroy(self) {
        // `self`をデストラクト。
        let Pair(first, second) = self;

        println!("Destroying Pair({}, {})", first, second);

        // `first`、`second`はスコープから抜け出すと同時に、解放されます。
    }
}

fn main() {
    let rectangle = Rectangle {
        // 関連関数はコロンを2つ挟んで呼び出すことができます。
        p1: Point::origin(),
        p2: Point::new(3.0, 4.0),
    };

    // メソッドはドット演算子を用いて呼び出されます。
    // 最初の引数`&self`は明示せずに受け渡されていることに注目。つまり
    // `rectangle.perimeter()` === `Rectangle::perimeter(&rectangle)`
    println!("Rectangle perimeter: {}", rectangle.perimeter());
    println!("Rectangle area: {}", rectangle.area());

    let mut square = Rectangle {
        p1: Point::origin(),
        p2: Point::new(1.0, 1.0),
    };

    // エラー！`rectangle`はイミュータブルですがこのメソッドは
    // ミュータブルなオブジェクトを必要とします。
    //rectangle.translate(1.0, 0.0);
    // TODO ^ この行をアンコメントしてみましょう。

    // OK！ミュータブルなオブジェクトはミュータブルなメソッドを呼び出せます。
    square.translate(1.0, 1.0);

    let pair = Pair(Box::new(1), Box::new(2));

    pair.destroy();

    // エラー！先ほどの`destroy`で`pair`はすでに消費されてしまっています。
    //pair.destroy();
    // TODO ^ この行をアンコメントしてみましょう。
}