5 構造体

[lemonadern]

https://doc.rust-jp.rs/book-ja/ch05-00-structs.html

[lemonadern]

構造体

• struct によって構造体を宣言する
• 各データ片には値に加えて型と名前を定義し、それをフィールドと呼ぶ
• Cの構造体やJSのデータオブジェクトと同じ概念

struct User {
    username: String,
    email: String,
    sign_in_count: u64,
    active: bool,
}

[lemonadern]

可変なインスタンスのフィールドは、変更することができる

let mut user1 = User {
    email: String::from("[email protected]"),
    username: String::from("someusername123"),
    active: true,
    sign_in_count: 1,
};

user1.email = String::from("[email protected]");

[lemonadern]

構造体のフィールドと変数が同じ名前のとき、フィールド初期化省略記法 を使って記述量を減らせる

fn build_user(email: String, username: String) -> User {
    User {
        email, // here
        username, // and here
        active: true,
        sign_in_count: 1,
    }
}

[lemonadern]

構造体更新記法 を利用して、すでに存在するインスタンスの値を利用して新たなインスタンスの初期化ができる

let user2 = User {
    email: String::from("[email protected]"),
    username: String::from("anotherusername567"),
    ..user1
};

[lemonadern]

tuple 構造体

• タプルにはフィールドの名前は無く、型のみが存在する
• タプル構造体を利用して、型は同じだが違う意味合いをもつタプルを宣言できる

struct Color(i32, i32, i32);
struct Point(i32, i32, i32);

let black = Color(0, 0, 0);
let origin = Point(0, 0, 0);

[lemonadern]

構造体に指定する文字列

let user1 = User {
    email: String::from("[email protected]"),
    username: String::from("someusername123"),
    active: true,
    sign_in_count: 1,
};

• 構造体が有効な間、文字列のフィールドはずっと有効である必要がある
  • だからemail, username に、参照であるリテラル（スライス）&str ではなく所有権のあるString を指定している
  • 他のものが所有しているデータへの参照を構造体に持ちたい場合は、ライフタイム という機能が必要

[lemonadern]

構造体のprintf デバッグ

• println! マクロには様々な整形があるが、デフォルトではDisplayとして実装された整形を利用する
• 構造体は、出力時の整形方法が自明でない（複数考えられる）ので、Display実装が提供されていない
• 構造体でも、println!("{:?}", rect1); とすれば、Debug と呼ばれる出力整形を利用できる
  • Debugトレイトは、開発者にとって有用な方法で構造体を出力させてくれる機能を提供している
  • Debug を構造体で使えるようにするには、構造体定義の直前に#[derive(debug)]という注釈をつける か、 自分で実装する必要がある

Rustでは、derive 注釈でトレイトを利用することによって、独自の型に対して便利な振る舞いを追加できる

[lemonadern]

Debug を使う

#[derive(Debug)]
struct Rectangle {
    width: u32,
    height: u32,
}

fn main() {
    let rect1 = Rectangle { width: 30, height: 50 };

    println!("rect1 is {:?}", rect1);
    println!("rect1 is {:#?}", rect1);
}

// output
// rect1 is Rectangle { width: 30, height: 50 }
// rect1 is Rectangle {
//    width: 30,
//    height: 50
//}

[lemonadern]

メソッド記法

• メソッドは、構造体（など）の文脈で定義される関数のようなもの
• 最初の引数は必ず self（メソッドが呼び出されている構造体インスタンス自身） になる

#[derive(Debug)]
struct Rectangle {
    width: u32,
    height: u32,
}

impl Rectangle {
    fn area(&self) -> u32 {
        self.width * self.height
    }
}

fn main() {
    let rect1 = Rectangle { width: 30, height: 50 };

    println!(
        "The area of the rectangle is {} square pixels.",
        rect1.area()
    );
}

• impl 構造体名 としてimplブロックを始める
• メソッドの最初の引数はself にする
  • 実際には、&self か、 &mut self になる
  • selfとしてインスタンスの所有権を奪うメソッドにすることは稀
    • メソッドがselfを何か別のものに変形し、変形後に呼び出し元が元のインスタンスを使用できないようにしたい場合に使用 されるらしい

[lemonadern]

• 同じ構造体に対するimpl ブロックは複数存在していてもよい

[lemonadern]

関連関数

• impl ブロック内に定義する、self を引数に取らない関数

• 関数であり、メソッドではない

• 例： String::from

• 新規の構造体インスタンスを返すコンストラクタとして利用される

// 1辺の長さだけを受け取り、正方形の`Rectangle` を返す関連関数 `square`
impl Rectangle {
    fn square(size: u32) -> Rectangle {
        Rectangle { width: size, height: size }
    }
}

[lemonadern]

関連関数の呼び出しは、

let sq = Rectangle::square(3);