github.com/shogo82148/std@v1.22.1-0.20240327122250-4e474527810c/text/template/funcs.go (about)

     1  // Copyright 2011 The Go Authors. All rights reserved.
     2  // Use of this source code is governed by a BSD-style
     3  // license that can be found in the LICENSE file.
     4  
     5  package template
     6  
     7  import (
     8  	"github.com/shogo82148/std/io"
     9  )
    10  
    11  // FuncMapは、名前から関数へのマッピングを定義するマップの型です。
    12  // 各関数は、単一の戻り値を持つか、または二つの戻り値を持つ必要があり、
    13  // その二つ目の型はエラーです。その場合、もし二つ目の（エラー）戻り値が実行中に非nilに評価された場合、
    14  // 実行は終了し、Executeはそのエラーを返します。
    15  //
    16  // Executeによって返されるエラーは、基礎となるエラーをラップします。それらをアンラップするには、[errors.As] を呼び出します。
    17  //
    18  // テンプレートの実行が引数リストを持つ関数を呼び出すとき、そのリストは
    19  // 関数のパラメータタイプに割り当て可能でなければなりません。任意のタイプの引数に適用することを意図した
    20  // 関数は、interface{}型または [reflect.Value] 型のパラメータを使用できます。同様に、任意の
    21  // タイプの結果を返すことを意図した関数は、interface{}または [reflect.Value] を返すことができます。
    22  type FuncMap map[string]any
    23  
    24  // HTMLEscapeは、プレーンテキストデータbのエスケープされたHTML相当をwに書き込みます。
    25  func HTMLEscape(w io.Writer, b []byte)
    26  
    27  // HTMLEscapeStringは、プレーンテキストデータsのエスケープされたHTML相当を返します。
    28  func HTMLEscapeString(s string) string
    29  
    30  // HTMLEscaperは、その引数のテキスト表現のエスケープされたHTML相当を返します。
    31  func HTMLEscaper(args ...any) string
    32  
    33  // JSEscapeは、プレーンテキストデータbのエスケープされたJavaScript相当をwに書き込みます。
    34  func JSEscape(w io.Writer, b []byte)
    35  
    36  // JSEscapeStringは、プレーンテキストデータsのエスケープされたJavaScript相当を返します。
    37  func JSEscapeString(s string) string
    38  
    39  // JSEscaperは、その引数のテキスト表現のエスケープされたJavaScript相当を返します。
    40  func JSEscaper(args ...any) string
    41  
    42  // URLQueryEscaperは、URLクエリに埋め込む形式に適した、その引数のテキスト表現のエスケープされた値を返します。
    43  func URLQueryEscaper(args ...any) string