i18n

Documentation

Index

• Constants
• Variables
• type Conf
• type Translator
  • func NewTranslator(conf Conf, efs embed.FS) *Translator
  • func (l *Translator) AddBundleFromEmbeddedFS(file embed.FS, path string) error
  • func (l *Translator) AddBundleFromFile(path string) error
  • func (l *Translator) AddLanguageSupport(lang language.Tag)
  • func (l *Translator) MatchLocalizer(lang string) *i18n.Localizer
  • func (l *Translator) Trans(ctx context.Context, msgId string) string
  • func (l *Translator) TransError(ctx context.Context, err error) error

Constants

const (
	Success            = "common.success"
	Failed             = "common.failed"
	UpdateSuccess      = "common.updateSuccess"
	UpdateFailed       = "common.updateFailed"
	CreateSuccess      = "common.createSuccess"
	CreateFailed       = "common.createFailed"
	DeleteSuccess      = "common.deleteSuccess"
	DeleteFailed       = "common.deleteFailed"
	TargetNotFound     = "common.targetNotExist"
	DatabaseError      = "common.databaseError"
	RedisError         = "common.redisError"
	AlreadyInit        = "init.alreadyInit"
	InitRunning        = "init.initializeIsRunning"
	ConstraintError    = "common.constraintError"
	ValidationError    = "common.validationError"
	NotSingularError   = "common.notSingularError"
	PermissionDeny     = "common.permissionDeny"
	ServiceUnavailable = "common.serviceUnavailable"
	ServiceBusy        = "common.serviceBusy"
	CacheError         = "common.cacheError"

	ApiRequestFailed = "sys.api.apiRequestFailed"
)

Variables

var LocaleFS embed.FS

Types

type Conf

type Conf struct {
	Dir string `json:",env=I18N_DIR"`
}

Conf is the configuration structure for i18n

type Translator

type Translator struct {
	// contains filtered or unexported fields
}

Translator is a struct storing translating data.

func NewTranslator

func NewTranslator(conf Conf, efs embed.FS) *Translator

NewTranslator returns a translator by I18n Conf. If Conf.Dir is empty, it will load paths in embedded FS. If Conf.Dir is not empty, it will load paths joined with Dir path. e.g. trans = i18n.NewTranslator(c.I18nConf, i18n2.LocaleFS)

func (*Translator) AddBundleFromEmbeddedFS

func (l *Translator) AddBundleFromEmbeddedFS(file embed.FS, path string) error

AddBundleFromEmbeddedFS adds new bundle into translator from embedded file system

func (*Translator) AddBundleFromFile

func (l *Translator) AddBundleFromFile(path string) error

AddBundleFromFile adds new bundle into translator from file path.

func (*Translator) AddLanguageSupport

func (l *Translator) AddLanguageSupport(lang language.Tag)

AddLanguageSupport adds supports for new language

func (*Translator) MatchLocalizer

func (l *Translator) MatchLocalizer(lang string) *i18n.Localizer

MatchLocalizer used to matcher the localizer in map

func (*Translator) Trans

func (l *Translator) Trans(ctx context.Context, msgId string) string

Trans used to translate any i18n string.

func (*Translator) TransError

func (l *Translator) TransError(ctx context.Context, err error) error

TransError translates the error message