gdドキュメント0.8.0

APIリファレンス

GD.html

HTMLの文字参照、タグ、テンプレートを扱います。テンプレートへ埋め込む値は、本文、属性、URL、スタイル、スクリプトのどこに使うかに応じてエスケープします。

メソッド

fill

fill(tpl: String, data: Dictionary, partials: Dictionary = {  }) -> String, Err

テンプレートに辞書の値を埋め込み、文字列を作ります。同じテンプレートを繰り返し使う場合は、template()で一度解析してからexecute()を呼びます。

引数

名前型省略時の値説明
tplString省略不可テンプレート原文。
dataDictionary省略不可テンプレート式に渡す値。
partialsDictionary{ }名前付きテンプレート断片。

戻り値

String, Err

描画した文字列。

エラー

処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。

解析や描画の失敗はErrで返ります。

関連文書

template

template(tpl: String, partials: Dictionary = {  }) -> GDHTMLTemplate, Err

テンプレートを解析し、繰り返し使えるオブジェクトを作ります。同じテンプレートへ何度も値を埋め込む場合に使います。テンプレートの解析時とHTMLの生成時には、それぞれエラーを確認してください。

引数

名前型省略時の値説明
tplString省略不可テンプレート原文。
partialsDictionary{ }描画で利用する名前付きテンプレート断片。

戻り値

GDHTMLTemplate, Err

再利用できるGDHTMLTemplate。

エラー

処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。

テンプレート構文が不正ならErrを返します。

関連文書

attr

attr(value: String) -> String
英語原文

Escape an HTML attribute value safely.

引数

名前型省略時の値説明
valueString省略不可保存、変換、検査など、この関数で処理する値。

戻り値

String

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

tag

tag(name: String, body: String, attrs: Dictionary = {  }) -> String
英語原文

Build an HTML tag from its name, body, and attributes.

引数

名前型省略時の値説明
nameString省略不可対象を登録・参照するための名前。
bodyString省略不可書き込む内容、またはレスポンスに含める本文。
attrsDictionary{ }文書の先頭などに付ける、名前と値を持った付加情報。

戻り値

String

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

escape

escape(text: String) -> String
英語原文

Escape HTML text.

引数

名前型省略時の値説明
textString省略不可調査・デコード・変換する文字列。入力自体は書き換えません。

戻り値

String

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

unescape

unescape(text: String) -> String
英語原文

Decode HTML entities into text.

引数

名前型省略時の値説明
textString省略不可調査・デコード・変換する文字列。入力自体は書き換えません。

戻り値

String

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

escape_async

escape_async(text: String) -> await String
英語原文

Dispatch HTML processing to CPU workers.

引数

名前型省略時の値説明
textString省略不可調査・デコード・変換する文字列。入力自体は書き換えません。

戻り値

await String

完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

unescape_async

unescape_async(text: String) -> await String
英語原文

Dispatch HTML entity decoding to a CPU worker.

引数

名前型省略時の値説明
textString省略不可調査・デコード・変換する文字列。入力自体は書き換えません。

戻り値

await String

完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

attr_async

attr_async(value: String) -> await String
英語原文

Dispatch HTML attribute escaping to a CPU worker.

引数

名前型省略時の値説明
valueString省略不可保存、変換、検査など、この関数で処理する値。

戻り値

await String

完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

tag_async

tag_async(name: String, body: String, attrs: Dictionary = {  }) -> await String
英語原文

Dispatch HTML tag construction to a CPU worker.

引数

名前型省略時の値説明
nameString省略不可対象を登録・参照するための名前。
bodyString省略不可書き込む内容、またはレスポンスに含める本文。
attrsDictionary{ }文書の先頭などに付ける、名前と値を持った付加情報。

戻り値

await String

完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

fill_async

fill_async(tpl: String, data: Dictionary, partials: Dictionary = {  }) -> await String, Err

テンプレートに辞書の値を埋め込み、文字列を作ります。同じテンプレートを繰り返し使う場合は、template()で一度解析してからexecute()を呼びます。

引数

名前型省略時の値説明
tplString省略不可テンプレート原文。
dataDictionary省略不可テンプレート式に渡す値。
partialsDictionary{ }名前付きテンプレート断片。

戻り値

await String, Err

描画した文字列。

完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。

エラー

処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。

解析や描画の失敗はErrで返ります。

関連文書