Struct Utf8Detect

#[non_exhaustive]
pub struct Utf8Detect {
    pub env: Option<HashMap<String, String>>,
    pub languages: Option<Vec<String>>,
}

Determine a UTF-8 locale to use and prepare the environment variables.

This class holds an optional list of preferred languages (if none is specified, the Utf8Detect::detect() method uses the ones in the UTF8_LANGUAGES variable by default), and an optional map of environment variables to augment (if none is specified, the current process environment is used by default).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

env: Option<HashMap<String, String>>

The environment variables to use instead of the current process’s ones.

languages: Option<Vec<String>>

The languages to look for in order of preference.

Implementations

impl Utf8Detect

pub fn new() -> Self

Prepare to detect a locale in the default manner.

pub fn detect(self) -> Result<Utf8Environment, UErr>

Detect a UTF-8 locale, prepare the environment. This method invokes the (mostly internal) get_utf8_vars() function which, in turn, invokes the (again mostly internal) detect_utf8_locale() one, which uses the external locale utility to obtain the list of available locales and then picks a UTF-8-capable one according to the list of preferred languages.

Errors

Propagate errors returned by get_utf8_vars().

pub fn with_env(self, env: HashMap<String, String>) -> Self

Specify the environment variables to record.

pub fn with_languages(self, langs: Vec<String>) -> Self

Specify the preferred languages to look for among the locales.

Trait Implementations

impl Debug for Utf8Detect

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

Formats the value using the given formatter.

impl Default for Utf8Detect

fn default() -> Utf8Detect

Returns the “default value” for a type.