Text.Localize.Types

This module contains data type definitions for the localize package.

Documentation

type LanguageId = String

Language identifier

type Context = ByteString

Context name

type TranslationSource = ByteString

String to be translated

data Translations

Stores translation catalogs for all supported languages

Constructors

Translations

Fields

• tMap :: Map LanguageId Catalog

Instances

Show Translations

Methods

showsPrec :: Int -> Translations -> ShowS

show :: Translations -> String

showList :: [Translations] -> ShowS

class (Monad m, Applicative m) => Localized m where

This is the main type class of the package. All functions work with any instance of this type class.

Note that this class only supports **getting** current language and translation, not setting them. Though concrete implementation can have its own ways to change language or context, these ways are not required by the localize package, and so are not declared in the type class.

Minimal complete definition

getLanguage, getTranslations

Methods

getLanguage :: m LanguageId

Obtain currently selected language ID.

getTranslations :: m Translations

Obtain currently loaded translations.

getContext :: m (Maybe Context)

Obtain currently selected localization context. Nothing means no specific context.

Instances

Monad m => Localized (LocalizeT m)

Methods

getLanguage :: LocalizeT m LanguageId

getTranslations :: LocalizeT m Translations

getContext :: LocalizeT m (Maybe Context)

toText :: TranslationSource -> Text

This assumes UTF-8 encoding.