Display - Rust By Example
Description: Rust by Example (RBE) is a collection of runnable examples that illustrate various Rust concepts and standard libraries.

## Keyboard shortcuts

Press `←` or `→` to navigate between chapters

Press `S` or `/` to search in the book

Press `?` to show this help

Press `Esc` to hide this help

# Display

`fmt::Debug`はコンパクトでクリーンであるようには見えませんね。大抵の場合は、アウトプットの見た目をカスタマイズしたほうが好ましいでしょう。これは`{}`を使用する`fmt::Display`を手動で実装することで可能です。実装はこのようになります。

    #![allow(unused)]
    fn main() {
    // （`use`を使用し、）`fmt`モジュールをインポートします。
    use std::fmt;

    // `fmt::Display`を実装するための構造体を定義します。
    // これは`Structure`と名付けられた、`i32`を含むタプル構造体です。
    struct Structure(i32);

    // `{}` というマーカーを使用するためには、
    // この型専用の`fmt::Display`というトレイトが実装されていなくてはなりません。
    impl fmt::Display for Structure {
        // このトレイトは`fmt`が正確にこの通りのシグネチャであることを要求します。
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            // 最初の要素だけを、与えられた出力ストリーム`f`に書き込みます。
            // 操作が成功したかどうかを表す`fmt::Result`を返します。
            // `write!`は`println!`に非常によく似た文法を使用していることに注目。
            write!(f, "{}", self.0)
        }
    }
    }

`fmt::Display`は`fmt::Debug`より綺麗かもしれませんが、`std`ライブラリの場合は問題が生じます。曖昧な型はどのように表示すれば良いでしょう？例えば、`std`ライブラリがあらゆる`Vec<T>`に対して単一のスタイルを提供していた場合、どのようなスタイルに整形すればよいでしょう？以下の2つのどちらかを選ぶべきでしょうか？

- `Vec<path>`: `/:/etc:/home/username:/bin` （`:`で分割）
- `Vec<number>`: `1,2,3` （`,`で分割）

答えはNOです。あらゆる型に対して理想的なスタイルなどというものはありませんし、`std`ライブラリによってそれが提供されているわけでもありません。`fmt::Display`は`Vec<T>`のようなジェネリックなコンテナ用に定義されているわけではありませんので、このような場合は`fmt::Debug`を使用するべきです。

ジェネリック でない コンテナ型の場合は、このような問題は生じませんので問題なく`fmt::Display`を実装することができます。

    use std::fmt; // `fmt`のインポート

    // 2つの数字を扱うための構造体です。出力を`Display`と比較するため`Debug`
    // を導出しています。
    #[derive(Debug)]
    struct MinMax(i64, i64);

    // `MinMax`用の`Display`を実装しています。
    impl fmt::Display for MinMax {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            // `self.number`でそれぞれのデータポイントを参照できます。
            write!(f, "({}, {})", self.0, self.1)
        }
    }

    // 比較のため、フィールドに名前をつけられる様な構造体を定義しましょう。
    #[derive(Debug)]
    struct Point2D {
        x: f64,
        y: f64,
    }

    // 先程と同様にして、`Point2D`用の`Display`を実装しています。
    impl fmt::Display for Point2D {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            // `x`と`y`のみが明示的になるようにカスタマイズ。
            write!(f, "x: {}, y: {}", self.x, self.y)
        }
    }

    fn main() {
        let minmax = MinMax(0, 14);

        println!("Compare structures:");
        println!("Display: {}", minmax);
        println!("Debug: {:?}", minmax);

        let big_range =   MinMax(-300, 300);
        let small_range = MinMax(-3, 3);

        println!("The big range is {big} and the small is {small}",
                 small = small_range,
                 big = big_range);

        let point = Point2D { x: 3.3, y: 7.2 };

        println!("Compare points:");
        println!("Display: {}", point);
        println!("Debug: {:?}", point);

        // `Debug`と`Display`は実装されていますが、`fmt::Binary`はされていないため
        // `{:b}`使用している以下の例はエラーになります。
        // println!("What does Point2D look like in binary: {:b}?", point);
    }

`fmt::Display`は実装されていますが、`fmt::Binary`はされていないので使用できません。`std::fmt`にはそのようなトレイトが数多くあり、それぞれに独自の実装が必要です。詳しくは`std::fmt`を参照してください。

### 演習

上記の例のアウトプットを確認し、`Point2D`構造体を参考として、複素数を格納するための`Complex`構造体を定義しましょう。うまく行けば以下のように出力されるはずです。

    Display: 3.3 +7.2i
    Debug: Complex { real: 3.3, imag: 7.2 }

    Display: 4.7 -2.3i
    Debug: Complex { real: 4.7, imag: -2.3 }

Bonus: Add a space before the `+`/`-` signs.

Hints in case you get stuck:

- Check the documentation for `Sign/#/0` in `std::fmt`.
- Bonus: Check `if`-`else` branching and the `abs` function.

### 参照

導出, `std::fmt`, マクロ, 構造体, トレイト, `use`