i18n

Documentation

Index

• Variables
• func Format(format string, args ...any) (msg string, err error)
• func ResetDefaultLocales()
• type Locale
  • func GetLocale(lang string) (Locale, bool)
• type LocaleStore
  • func NewLocaleStore() LocaleStore

Variables

var (
	ErrLocaleAlreadyExist = util.SilentWrap{Message: "lang already exists", Err: util.ErrAlreadyExist}
	ErrUncertainArguments = util.SilentWrap{Message: "arguments to i18n should not contain uncertain slices", Err: util.ErrInvalidArgument}
)

var DefaultLocales = NewLocaleStore()

Functions

func Format

func Format(format string, args ...any) (msg string, err error)

Format formats provided arguments for a given translated message

func ResetDefaultLocales

func ResetDefaultLocales()

ResetDefaultLocales resets the current default locales NOTE: this is not synchronized

Types

type Locale

type Locale interface {
	// TrString translates a given key and arguments for a language
	TrString(trKey string, trArgs ...any) string
	// TrHTML translates a given key and arguments for a language, string arguments are escaped to HTML
	TrHTML(trKey string, trArgs ...any) template.HTML
	// HasKey reports if a locale has a translation for a given key
	HasKey(trKey string) bool
}

func GetLocale

func GetLocale(lang string) (Locale, bool)

GetLocale returns the locale from the default locales

type LocaleStore

type LocaleStore interface {
	io.Closer

	// SetDefaultLang sets the default language to fall back to
	SetDefaultLang(lang string)
	// ListLangNameDesc provides paired slices of language names to descriptors
	ListLangNameDesc() (names, desc []string)
	// Locale return the locale for the provided language or the default language if not found
	Locale(langName string) (Locale, bool)
	// HasLang returns whether a given language is present in the store
	HasLang(langName string) bool
	// AddLocaleByIni adds a new language to the store
	AddLocaleByIni(langName, langDesc string, source, moreSource []byte) error
}

LocaleStore provides the functions common to all locale stores

func NewLocaleStore

func NewLocaleStore() LocaleStore

NewLocaleStore creates a static locale store