Struct Intl

pub struct Intl { /* private fields */ }

Internationalization index file.

Translations are loaded by convention from the directory pointed to by the arb-dir. The default convention is to use app as the prefix concatenated with a lowercase language identifier delimited by an underscore. Language identifiers in file names should use underscores and not hyphens. For example, the file name for the EN-US language would be app_en_us.arb.

Implementations

impl Intl

pub fn new(path: impl AsRef<Path>) -> Result<Self>

Load the YAML file using the default file name prefix.

pub fn new_with_prefix( path: impl AsRef<Path>, name_prefix: Option<String>, ) -> Result<Self>

Load the YAML file with a given file name prefix.

pub fn arb_dir(&self) -> &str

Directory for application resource bundles.

pub fn template_arb_file(&self) -> &str

Template application resource bundle.

pub fn name_prefix(&self) -> &str

Prefix used to compute file names.

pub fn overrides_dir(&self) -> Option<&str>

Directory for override files.

pub fn template_language(&self) -> &Lang

Language of the template application resource bundle.

pub fn cache(&self) -> &ArbCache

Get the cache of original translations.

pub fn template_content(&self) -> Result<ArbFile>

Load and parse the template application resource bundle.

pub fn parent_path(&self) -> Result<&Path>

Compute the parent of the index file.

pub fn file_path(&self, lang: Lang) -> Result<PathBuf>

Path to a language file.

pub fn format_file_name(&self, lang: Lang) -> String

Format a language to a file name.

pub fn parse_file_name(&self, path: impl AsRef<Path>) -> Option<Lang>

Parse a file path to a language.

pub fn arb_directory(&self) -> Result<PathBuf>

Compute the application resource bundle directory relative to the parent of the internationalization index file.

pub fn list_translated(&self) -> Result<BTreeMap<Lang, PathBuf>>

List translations in the configured arb-dir.

pub fn list_directory( &self, dir: impl AsRef<Path>, ) -> Result<BTreeMap<Lang, PathBuf>>

List translated languages in a directory.

pub fn load_overrides( &self, dir: impl AsRef<Path>, languages: Option<Vec<Lang>>, ) -> Result<HashMap<Lang, ArbFile>>

Attempt to load override definitions.

If a languages list is given only load the given languages.

pub fn load(&self, lang: Lang) -> Result<ArbFile>

Load a language file from disc.

pub fn load_or_default(&self, lang: Lang) -> Result<ArbFile>

Load a language file if it exists otherwise use an empty file.

pub async fn translate( &mut self, api: &DeeplApi, options: TranslationOptions, ) -> Result<TranslateResult>

Translate to a target language.

Placeholders are converted to XML tags and ignored from translation to preserve the placeholder names.

Trait Implementations

impl Debug for Intl

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.