安全な宝箱

不透明型

Gleamの不透明型とは、その型を定義したモジュールだけが値を作ったりパターンマッチしたりできるカスタム型のことです。決まった使い方だけを許したい型を作るときに便利です。

不透明型は、opaqueキーワードを使って定義します。

pub opaque type PositiveInt {
  PositiveInt(inner: Int)
}

このPositiveInt型は、整数を使いたいけれど0以上でなければならない場面で使います。通常のGleamのIntは負の値も取れるため、そのままでは使えません。

この型を定義したモジュールでは、内側の整数値を取り出す関数と、PositiveInt型を作る関数を定義できます。後者は、値が正でなければエラーを返します。

pub fn from_int(i: Int) -> Result(PositiveInt, String) {
  case i {
    _ if i < 0 -> Error("Value must be positive")
    _ -> Ok(PositiveInt(i))
  }
}

pub fn to_int(i: PositiveInt) -> Int {
  i.inner
}

このAPIがあれば、ほかのモジュールが負の値でPositiveIntを作ることはできません。そのため、PositiveIntを受け取る関数は、その値が正であることを確信できます。