gi18n

Documentation

Overview

Package gi18n implements internationalization and localization.

Index

• Constants
• func GetContent(key string, language ...string) string
• func SetDelimiters(left, right string)
• func SetLanguage(language string)
• func SetPath(path string) error
• func T(content string, language ...string) string
• func Tf(format string, values ...interface{}) string
• func Tfl(language string, format string, values ...interface{}) string
• func Translate(content string, language ...string) string
• func TranslateFormat(format string, values ...interface{}) string
• func TranslateFormatLang(language string, format string, values ...interface{}) string
• type Manager
  • func Instance(name ...string) *Manager
  • func New(options ...Options) *Manager
  • func (m *Manager) GetContent(key string, language ...string) string
  • func (m *Manager) SetDelimiters(left, right string)
  • func (m *Manager) SetLanguage(language string)
  • func (m *Manager) SetPath(path string) error
  • func (m *Manager) T(content string, language ...string) string
  • func (m *Manager) Tf(format string, values ...interface{}) string
  • func (m *Manager) Tfl(language string, format string, values ...interface{}) string
  • func (m *Manager) Translate(content string, language ...string) string
  • func (m *Manager) TranslateFormat(format string, values ...interface{}) string
  • func (m *Manager) TranslateFormatLang(language string, format string, values ...interface{}) string
• type Options
  • func DefaultOptions() Options

Constants

const (
	// Default group name for instance usage.
	DefaultName = "default"
)

Functions

func GetContent

func GetContent(key string, language ...string) string

GetValue retrieves and returns the configured content for given key and specified language. It returns an empty string if not found.

func SetDelimiters

func SetDelimiters(left, right string)

SetDelimiters sets the delimiters for translator.

func SetLanguage

func SetLanguage(language string)

SetLanguage sets the language for translator.

func SetPath

func SetPath(path string) error

SetPath sets the directory path storing i18n files.

func T

func T(content string, language ...string) string

T is alias of Translate for convenience.

func Tf

func Tf(format string, values ...interface{}) string

Tf is alias of TranslateFormat for convenience.

func Tfl

func Tfl(language string, format string, values ...interface{}) string

Tfl is alias of TranslateFormatLang for convenience.

func Translate

func Translate(content string, language ...string) string

Translate translates <content> with configured language and returns the translated content. The parameter <language> specifies custom translation language ignoring configured language.

func TranslateFormat

func TranslateFormat(format string, values ...interface{}) string

TranslateFormat translates, formats and returns the <format> with configured language and given <values>.

func TranslateFormatLang

func TranslateFormatLang(language string, format string, values ...interface{}) string

TranslateFormatLang translates, formats and returns the <format> with configured language and given <values>. The parameter <language> specifies custom translation language ignoring configured language. If <language> is given empty string, it uses the default configured language for the translation.

Types

type Manager

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

Manager, it is concurrent safe, supporting hot reload.

func Instance

func Instance(name ...string) *Manager

Instance returns an instance of Resource. The parameter <name> is the name for the instance.

func New

func New(options ...Options) *Manager

New creates and returns a new i18n manager. The optional parameter <option> specifies the custom options for i18n manager. It uses a default one if it's not passed.

func (*Manager) GetContent

func (m *Manager) GetContent(key string, language ...string) string

GetValue retrieves and returns the configured content for given key and specified language. It returns an empty string if not found.

func (*Manager) SetDelimiters

func (m *Manager) SetDelimiters(left, right string)

SetDelimiters sets the delimiters for translator.

func (*Manager) SetLanguage

func (m *Manager) SetLanguage(language string)

SetLanguage sets the language for translator.

func (*Manager) SetPath

func (m *Manager) SetPath(path string) error

SetPath sets the directory path storing i18n files.

func (*Manager) T

func (m *Manager) T(content string, language ...string) string

T is alias of Translate for convenience.

func (*Manager) Tf

func (m *Manager) Tf(format string, values ...interface{}) string

Tf is alias of TranslateFormat for convenience.

func (*Manager) Tfl

func (m *Manager) Tfl(language string, format string, values ...interface{}) string

Tfl is alias of TranslateFormatLang for convenience.

func (*Manager) Translate

func (m *Manager) Translate(content string, language ...string) string

Translate translates <content> with configured language. The parameter <language> specifies custom translation language ignoring configured language.

func (*Manager) TranslateFormat

func (m *Manager) TranslateFormat(format string, values ...interface{}) string

TranslateFormat translates, formats and returns the <format> with configured language and given <values>.

func (*Manager) TranslateFormatLang

func (m *Manager) TranslateFormatLang(language string, format string, values ...interface{}) string

TranslateFormatLang translates, formats and returns the <format> with configured language and given <values>. The parameter <language> specifies custom translation language ignoring configured language. If <language> is given empty string, it uses the default configured language for the translation.

type Options

type Options struct {
	Path       string   // I18n files storage path.
	Language   string   // Local language.
	Delimiters []string // Delimiters for variable parsing.
}

Options is used for i18n object configuration.

func DefaultOptions

func DefaultOptions() Options

DefaultOptions creates and returns a default options for i18n manager.