無駄と文化

先日の記事でも書いたとおり、最近健康志向になってきてダイエットっぽいことをしています。

blog.mudatobunka.org

そんなわけで毎日体重計に乗ったりしてるわけですが。日々の体重データが蓄積されてくると「このデータを広く世界中の人が使えるように公開したいな」という思いが湧いてきました。

というわけで、三井の体重推移をリアルタイムで取得できる GraphQL API を作りました。
それがこれです。

todays-mitsui-trend.deno.dev

クエリを叩くと体重, 体脂肪率, 内臓脂肪, 骨量などを取得できます。私が体重計に乗ってから6時間以内には反映されるはずなのでほぼリアルタイムです。

技術選定

先日の記事では「バックエンドを Go にするか Rust にするか迷っている」と書きましたが。悩み抜いた結果私がたどり着いた結果は Deno でした。
正確に云うと Deno はランタイムなので、TypeScript 製ですね。

選定基準としては、

TypeScript だとホスティングが楽そう (Vercel とか Deno Deploy とかでやりたい)
Deno Deploy を使って見たい

といったところです。

特に Deno Deploy は最近 Deno KV という Key-Value ストアをサービスとしてリリースしていて。これを使えばサーバーもデータベースも用意せず実行コードを書くだけで完結しそうだったので試してみました。

Deno を使った感想

なんやかんやで Deno をちゃんと使ったのが初めてだったので、ここに感想を書き記しておきます。

バンドラーやフォーマッターの設定のことを考えなくていいので楽でした。
TypeScript のプロジェクト始めるとき毎回 Vite, Rollup, Webpack のうちどれ使うか迷って、設定の方法をググってたのが無くなってストレスフリーでした。

(余談ですけど、半年ぶりに Webpack の設定をググると同じことやろうとしてるのにプラグインとか設定の記述とかガラッと変えないといけなくてビビりませんか？あれ何？)

Deno Deploy & Deno KV を使った感想

楽でした。
GitHub リポジトリと連携させておくと勝手に依存をインストールしてデプロイしてくれるので。

レイテンシや安定性については本気使いしていないのでよく分かりません。
とくに Deno KV はまだクローズドベータですしね。覚悟して来てる人だけが使うべきだと思います。

私は Deno が開発されているモチベーションや価値観に共感しているので、それありきで楽しんで使えたという感じでした。

まとめ

つづいては可視化をやろうかなと考えています。
Astro でページ作って Deno Deploy に置く感じかな、たぶん。

2023-09-06 18:11:00 追記
この記事を公開した瞬間に Deno KV がクローズドベータからオープンベータになりました！
Deno Deploy と Deno KV を使ってみんなも軽率に個人情報を API にして公開しよう！！

私からは以上です。

Rust では所有権と借用, そしてライフタイムという概念があるため、値そのものを取り扱うより参照 (借用) を取り扱うことが難しくなりがちです。
特に関数から参照を返そうとすると、そこにはライフタイムの概念が絡んできます。

例えば下記のように関数内から文字列スライスを返す場合、

fn f() -> &str {
    "str"
}

このコードはこのままではコンパイルできません。

コンパイラはこのようなメッセージを出してきます、

missing lifetime specifier. expected named lifetime parameter.
help: consider using the `'static` lifetime

意訳:
ライフタイム指定がありません。ライフタイムパラメータが必要です。
help: `'static` ライフタイムを検討してください

実際、コンパイラの言うとおり 'static ライフタイムを明示すると先ほどのコードはコンパイル可能になります。

fn f() -> &'static str {
    "str"
}

いったい何が起こっているのか、どんなシチュエーションでも 'static さえ付ければ万事解決なのか、そのへんを解説していきます。

`'static` ライフタイムとは何か

Rust のライフタイム注釈には特別な意味を持つキーワードがあります。
それが 'static で全てのライフタイムのなかで最も長いものを表します。つまりはプログラムが起動しているあいだずっとということです。

先ほどの例で -> &str ではコンパイルが通らず -> &'static str ならコンパイルが通るのは、ライフタイムを 'static とすることで「関数内の処理が終わっても値が drop されず有効であり続ける」ことを明示しているからでしょう。

ではどのような値が &'static になれるのか、実際にコードを書いて試してみましょう。

(最後まで読むのが面倒なひとのために) 3行まとめ

スカラー型は &'static になれる
複合型も &'static になれる
ヒープに置かれた値を参照している構造体は &'static になれない
意図的にメモリをリークすることで &'static を得るテクニックがある

この記事で示したサンプルコードは Rust Playground に置いています。

play.rust-lang.org

スカラー型は `&'static` になれる

まずはスカラー型から。
Rust には6種類のスカラー型があります。

符号付き整数: i8, i16, i32, i64, i128, isize
符号無し整数: u8, u16, u32, u64, u128, usize
浮動小数点数: f32, f64
Unicode 文字: char
真理値: true, false
ユニット型: ()

これらは全て &'static になれます。
サンプルコードを示すと、

fn i8()   -> &'static i8   { &-1 }
fn u8()   -> &'static u8   { &42 }
fn f64()  -> &'static f64  { &std::f64::consts::E }
fn char() -> &'static char { &'🦀' }
fn bool() -> &'static bool { &true }
fn unit() -> &'static ()   { &() }

fn main() {
    println!("{:?}", i8());    // => -1
    println!("{:?}", u8());    // => 42
    println!("{:?}", f64());   // => 2.718281828459045
    println!("{:?}", char());  // => '🦀'
    println!("{:?}", bool());  // => true
    println!("{:?}", unit());  // => ()
}

このように。

これらの型はどれも Sized で Copy でもあるので 'static ライフタイムとして取り扱えることはイメージに合うのではないでしょうか。

複合型も `&'static` になれる

タプル, スライス, 文字列スライスも (要素が &'static になれる型であれば) &'static になれます。

fn tuple() -> &'static (u8, char) { &(42, '🦀') }
fn slice() -> &'static [char]     { &['🦀'] }
fn str()   -> &'static str        { "str" }

fn main() {
    println!("{:?}", tuple());  // => (42, '🦀')
    println!("{:?}", slice());  // => ['🦀']
    println!("{:?}", str());    // => "str"
}

このことから分かるのは Sized ではない型でも &'static になれるということです。
Sized であることは必要条件ではないんですね。

返り値の型が `&[T]` や `&str` でも `&'static` になれない場合がある

最終的な返り値が &[T] や &str であっても、それがヒープに置かれた値の参照だと &'static になれないようです。
どういうことかと云うと、

// ↓↓↓ このようには書けない, &vec!['🦀'] のライフタイムは 'static ではない
fn vec() -> &'static Vec<char> {
    &vec!['🦀']
    // ^----------
    // ||
    // |temporary value created here
    // returns a reference to data owned by the current function
}

// ↓↓↓ このようには書けない, &String::from("str") のライフタイムは 'static ではない
fn string() -> &'static String {
    &String::from("str")
    // ^-------------------
    // ||
    // |temporary value created here
    // returns a reference to data owned by the current function
}

上記の例はコンパイルが通りません。(エラーメッセージをコメントで併記しています)

vec!['🦀'] の型は Vec<char>, &vec!['🦀'] の型は &[char] です。
String::from("str") の型は String, &String::from("str") の型は &str です。

最終的に返されるのは &[char] や &str で、一つ前の例と同じです。関数のシグネチャも同じ。
ですがエラーが出てコンパイルできません。

Vec<T> や String の値を生成したとき、内部的にスライス (文字列スライス) が生成されてヒープに置かれます。
Vec<T> や String はヒープ上のスライスを指すポインタを所有していることになります。そして & によって参照を得ると、ヒープ上にあるスライスの参照が返るわけです。

これが (おそらく) エラーの原因で。ヒープ上に置かれた値の参照は &'static になれないようです。
-> &'static 付けとけば 'static になれるわけじゃないってことですね。

構造体が `&'static` になれる条件

構造体について考えていきましょう。
もっともシンプルでオーソドックスな例として Option<T> を取り上げます。一例として Option<u8> は&'static になれます。

fn some() -> &'static Option<u8> { &Some(42) }
fn none() -> &'static Option<u8> { &None }

fn main() {
    println!("{:?}", some());  // => Some(42)
    println!("{:?}", none());  // => None
}

Option<T> のような組み込みの型だけでなく、ユーザーが定義した構造体でも同じように &'static になれます。

#[derive(Debug)]
struct Foo<T>(T);

fn struct() -> &'static Foo<u8> { &Foo(42) }

fn main() {
    println!("{:?}", struct());  // => Foo(42)
}

参照を内包している構造体も `&'static` になれる

Vec<T>, String の例を見て「参照を内包していると &'static になれないのかな？」と思いかけましたが、どうやらそうではないようです。
下記の例はコンパイルが通ります。

// &'static T を含む構造体
#[derive(Debug)]
struct Bar<'a, T>(&'a T);

// &'static な参照を内包する構造体 Bar の &'static な参照を返す
fn struct_ref() -> &'static Bar<'static, u8> { &Bar(&42) }

fn main() {
    println!("{:?}", struct_ref());  // => Bar(42)
}

重要なのは参照している値がスタックに置かれているか/ヒープに置かれているかという点です。

ヒープに置いた値を内包している構造体は `&'static` になれない

試しにBox<T> を使ってヒープに置いた値を所有させるとコンパイルエラーを吐くようになります。

#[derive(Debug)]
struct Baz<T>(Box<T>);

// error[E0515]: cannot return reference to temporary value
fn struct_box() -> &'static Baz<u8> {
    &Baz(Box::new(42))
//  ^-----------------
//  ||
//  |temporary value created here
//  returns a reference to data owned by the current function
}

-> &'static 付けとけば 'static になれるわけじゃないってことですね。(2回目)

構造体が内包している型は ?Sized でも構わない

スライス &[T] や文字列スライス &str が &'static になれることからも分かるように、型が Sized である必要はありません。
?Sized な型を内包している構造体でも &'static になれます。

// &'static T を含む構造体
// T が Sized でなくてもいい
#[derive(Debug)]
struct Qux<'a, T: ?Sized>(&'a T);

// &'static な参照を内包する構造体 Qux の &'static な参照を返す 
fn struct_ref_unsized() -> &'static Qux<'static, str> {
    &Qux("str is unsized")
}

fn main() {
    println!("{:?}", struct_ref_unsized());
    // => Qux("str is unsized")
}

意図的にメモリをリークすることで `&'static` を得る

ここからはおまけです。

`Vec<T>` から無理やり `&'static [T]` を得る

.leak() メソッドを使うことで Vec<T> から &[T] を取ることができ、そのようにして得たスライスは &'static になれます。

fn vec_leak() -> &'static [char] {
    // leak() メソッドを使って意図的にメモリリークさせると
    // Vec<char> から &'static [char] を取り出せる
    vec!['🦀'].leak()
}

fn main() {
    println!("{:?}", vec_leak());  // => ['🦀']
}

String から無理やり `&'static str` を得る

String にも .leak() メソッドがあります。それを使うと、

fn string_leak() -> &'static str {
    // leak() メソッドを使って意図的にメモリリークさせると
    // String から &'static str を取り出せる
    String::from("str").leak()
}

fn main() {
    println!("{:?}", string_leak());  // => "str"
}

このように書けます。

メモリをリークすることさえも標準的な手段が用意されていて、ちゃんと型がついているのが面白いですね。
このあたりの思想や事情については「Rust 裏本」にある解説が興味深かったのでオススメです。

Rust 裏本 > リーク

まとめ

どんな値が &'static になれるのか探っていきました。
体系的にまとまったレポートではないですが理解の助けになれば幸いです。

私からは以上です。

謝辞

.leak() メソッドを使ったテクニックについては @Toru31415926535 さんに教えてもらいました。
また X (旧: Twitter) で「ライフタイム何も分からん」と言ってるところに @nobkz さんから助言をもらい理解の助けになりました。
ありがとうございました。

無駄と文化

実用的ブログ

「若さ」とは何だろう

自分の体重を全世界に公開するために GraphQL API を作った

技術選定

Deno を使った感想

Deno Deploy & Deno KV を使った感想

まとめ

Rust ではどんな値が &'static になれるのか

`'static` ライフタイムとは何か

(最後まで読むのが面倒なひとのために) 3行まとめ

スカラー型は `&'static` になれる

複合型も `&'static` になれる

返り値の型が `&[T]` や `&str` でも `&'static` になれない場合がある

構造体が `&'static` になれる条件

参照を内包している構造体も `&'static` になれる

ヒープに置いた値を内包している構造体は `&'static` になれない

構造体が内包している型は ?Sized でも構わない

意図的にメモリをリークすることで `&'static` を得る

`Vec<T>` から無理やり `&'static [T]` を得る

String から無理やり `&'static str` を得る

まとめ

謝辞

技術選定

Deno を使った感想

Deno Deploy & Deno KV を使った感想

まとめ

'static ライフタイムとは何か

(最後まで読むのが面倒なひとのために) 3行まとめ

スカラー型は &'static になれる

複合型も &'static になれる

返り値の型が &[T] や &str でも &'static になれない場合がある

構造体が &'static になれる条件

参照を内包している構造体も &'static になれる

ヒープに置いた値を内包している構造体は &'static になれない

構造体が内包している型は ?Sized でも構わない

意図的にメモリをリークすることで &'static を得る

Vec<T> から無理やり &'static [T] を得る

String から無理やり &'static str を得る

まとめ

謝辞

`'static` ライフタイムとは何か

スカラー型は `&'static` になれる

複合型も `&'static` になれる

返り値の型が `&[T]` や `&str` でも `&'static` になれない場合がある

構造体が `&'static` になれる条件

参照を内包している構造体も `&'static` になれる

ヒープに置いた値を内包している構造体は `&'static` になれない

意図的にメモリをリークすることで `&'static` を得る

`Vec<T>` から無理やり `&'static [T]` を得る

String から無理やり `&'static str` を得る