tbs

Documentation

Index

• func Clear()
• func Format(locale, format string, args ...any) string
• func GetBool(locale, key string, defs ...bool) bool
• func GetBundle(locale string) *ini.Ini
• func GetFloat(locale, key string, defs ...float64) float64
• func GetInt(locale, key string, defs ...int) int
• func GetInt64(locale, key string, defs ...int64) int64
• func GetText(locale, key string, defs ...string) string
• func Load(root string) error
• func LoadFS(fsys fs.FS, root string) error
• func Replace(locale, format string, args ...any) string
• func SetDefault(tbs *TextBundles)
• type TextBundles
  • func Default() *TextBundles
  • func NewTextBundles(extensions ...string) *TextBundles
  • func (tbs *TextBundles) Clear()
  • func (tbs *TextBundles) Format(locale, format string, args ...any) string
  • func (tbs *TextBundles) GetBool(locale, key string, defs ...bool) bool
  • func (tbs *TextBundles) GetBundle(locale string) *ini.Ini
  • func (tbs *TextBundles) GetFloat(locale, key string, defs ...float64) float64
  • func (tbs *TextBundles) GetInt(locale, key string, defs ...int) int
  • func (tbs *TextBundles) GetInt64(locale, key string, defs ...int64) int64
  • func (tbs *TextBundles) GetText(locale, key string, defs ...string) string
  • func (tbs *TextBundles) Load(root string) error
  • func (tbs *TextBundles) LoadFS(fsys fs.FS, root string) error
  • func (tbs *TextBundles) Replace(locale, format string, args ...any) string

Functions

func Clear

func Clear()

Clear clear all loaded text resources

func Format

func Format(locale, format string, args ...any) string

Format translate content to target language.

func GetBool

func GetBool(locale, key string, defs ...bool) bool

GetBool get a bool value of the key from the text bundle. if not found or convert error, returns the default defs[0] bool value

func GetBundle

func GetBundle(locale string) *ini.Ini

GetBundle get target locale ini bundle

func GetFloat

func GetFloat(locale, key string, defs ...float64) float64

GetFloat get a float64 value of the key from the text bundle. if not found or convert error, returns the default defs[0] float64 value

func GetInt

func GetInt(locale, key string, defs ...int) int

GetInt get a int value of the key from the text bundle. if not found or convert error, returns the default defs[0] int value

func GetInt64

func GetInt64(locale, key string, defs ...int64) int64

GetInt64 get a int64 value of the key from the text bundle. if not found or convert error, returns the default defs[0] int64 value

func GetText

func GetText(locale, key string, defs ...string) string

GetText get the locale text by key.

func Load

func Load(root string) error

Load glob and parse text files under root path

func LoadFS

func LoadFS(fsys fs.FS, root string) error

LoadFS glob and parse template files from FS

func Replace

func Replace(locale, format string, args ...any) string

Replace use strings.Replacer to translate content to the locale language.

func SetDefault

func SetDefault(tbs *TextBundles)

SetDefault set the default TextBundles instance used by the package-level functions.

Types

type TextBundles

type TextBundles struct {
	Extensions []string  // file extensions
	Timestamp  time.Time // modified timestamp
	// contains filtered or unexported fields
}

TextBundles a localized text resource bundle container

func Default

func Default() *TextBundles

Default returns the default TextBundles instance used by the package-level functions.

func NewTextBundles

func NewTextBundles(extensions ...string) *TextBundles

NewTextBundles returns a new TextBundles instance

func (*TextBundles) Clear

func (tbs *TextBundles) Clear()

Clear clear all loaded text resources

func (*TextBundles) Format

func (tbs *TextBundles) Format(locale, format string, args ...any) string

Format use fmt.Sprrintf to translate content to the locale language.

func (*TextBundles) GetBool

func (tbs *TextBundles) GetBool(locale, key string, defs ...bool) bool

GetBool get a bool value of the key from the text bundle. if not found or convert error, returns the default defs[0] bool value

func (*TextBundles) GetBundle

func (tbs *TextBundles) GetBundle(locale string) *ini.Ini

GetBundle get target locale ini bundle

func (*TextBundles) GetFloat

func (tbs *TextBundles) GetFloat(locale, key string, defs ...float64) float64

GetFloat get a float64 value of the key from the text bundle. if not found or convert error, returns the default defs[0] float64 value

func (*TextBundles) GetInt

func (tbs *TextBundles) GetInt(locale, key string, defs ...int) int

GetInt get a int value of the key from the text bundle. if not found or convert error, returns the default defs[0] int value

func (*TextBundles) GetInt64

func (tbs *TextBundles) GetInt64(locale, key string, defs ...int64) int64

GetInt64 get a int64 value of the key from the text bundle. if not found or convert error, returns the default defs[0] int64 value

func (*TextBundles) GetText

func (tbs *TextBundles) GetText(locale, key string, defs ...string) string

GetText get the locale text by key.

func (*TextBundles) Load

func (tbs *TextBundles) Load(root string) error

Load glob and parse text files under root path

func (*TextBundles) LoadFS

func (tbs *TextBundles) LoadFS(fsys fs.FS, root string) error

LoadFS glob and parse template files from FS

func (*TextBundles) Replace

func (tbs *TextBundles) Replace(locale, format string, args ...any) string

Replace use strings.Replacer to translate content to the locale language.