API リファレンス

hypersig クレートの項目を、組み立てるものごとにまとめています。名前をクリックすると、その項目の完全なドキュメントを開けます。

API ドキュメントの全体は、このサイトと同じコミットから rustdoc で生成したもので、すべてのメソッドのシグネチャと例を載せています。ここに並べたのはよく使う項目です。各項目にはドキュメントコメントの最初の 1 文を訳して添え、長い文は短くしています。

ページ	扱う内容
Page	`Page` はページ全体の HTML 文書です。タイトル、シグナルの初期値、ランタイムを持ちます。
El	`El<S>` は、シグナルが `S` のページに置く HTML 要素です。メソッドが要素を返すので、要素の木を 1 つの式で書けます。
html の関数	`hypersig::html` モジュールは要素、リスト、条件付きで現れる部分を組み立てます。
Signals と Sig	`Signals` はページの状態を持つ構造体が実装するトレイトで、`Sig<S, T>` はそのフィールドの 1 つを指す型付きの参照です。
Expr	`Expr<S, T>` は `S` のシグナルを読む式で、ブラウザで `T` の値に評価されます。
Stmt	`Stmt<S>` は `S` のシグナルを扱う文で、イベントが起きるとブラウザが実行します。
NodeRef	`NodeRef<S>` は、シグナルが `S` のページにある要素に付ける名前で、その要素の DOM のメソッドを命令的に呼び出すときに使います。
Action と Call	`Action<S, A>` は、シグナルが `S` のページから呼ぶサーバーのエンドポイントで、引数 `A` を受け取ります。
Form と Validate	`Form<T>` は、フォームの値、開始時の値、訪問者がフォームにしたことを持ちます。`Validate` は、ブラウザとサーバーの両方が評価するルールを与えます。
Patches と Fragment	`Patches<S>` はハンドラが返す値です。シグナルの新しい値と描き直したフラグメントを持ち、ブラウザはそれらを順に適用します。
Route と Link	`Route<P, Q>` はパスで配信するページで、パスのパラメータは `P`、クエリパラメータは `Q` です。`Link<S>` はそのページへのリンクです。
RouterExt	`RouterExt` は axum の `Router` に hypersig のルートを追加します。`axum` の feature が必要で、この feature は既定で有効です。

スタイルは hypersig::style にあります。これは hypersig_style クレートを再エクスポートしたモジュールです。スタイルと style モジュールをご覧ください。