Struct pango::language::Language

pub struct Language(_);

The Language structure is used to represent a language.

Language pointers can be efficiently copied and compared with each other.

Implementations

impl Language

pub fn from_string(language: &str) -> Self

Take a RFC-3066 format language tag as a string and convert it to a Language pointer that can be efficiently copied (copy the pointer) and compared with other language tags (compare the pointer.)

This function first canonicalizes the string by converting it to lowercase, mapping ‘_’ to ‘-’, and stripping all characters other than letters and ‘-’.

Use default() if you want to get the Language for the current locale of the process.

language

a string representing a language tag, or None

Returns

an opaque pointer to a Language structure, or None if language was None. The returned pointer will be valid forever after, and should not be freed.

pub fn to_string(&self) -> GString

Gets the RFC-3066 format string representing the given language tag.

Returns

a string representing the language tag. This is owned by Pango and should not be freed.

pub fn matches(&self, range_list: &str) -> bool

Checks if a language tag matches one of the elements in a list of language ranges. A language tag is considered to match a range in the list if the range is ‘*’, the range is exactly the tag, or the range is a prefix of the tag, and the character after it in the tag is ‘-’.

range_list

a list of language ranges, separated by ‘;’, ‘:’, ‘,’, or space characters. Each element must either be ‘*’, or a RFC 3066 language range canonicalized as by from_string()

Returns

true if a match was found.

pub fn includes_script(&self, script: Script) -> bool

Determines if script is one of the scripts used to write self. The returned value is conservative; if nothing is known about the language tag self, true will be returned, since, as far as Pango knows, script might be used to write self.

This routine is used in Pango’s itemization process when determining if a supplied language tag is relevant to a particular section of text. It probably is not useful for applications in most circumstances.

This function uses scripts() internally.

script

a Script

Returns

true if script is one of the scripts used to write self or if nothing is known about self (including the case that self is None), false otherwise.

pub fn scripts(&self) -> Vec<Script>

Determines the scripts used to to write self. If nothing is known about the language tag self, or if self is None, then None is returned. The list of scripts returned starts with the script that the language uses most and continues to the one it uses least.

The value num_script points at will be set to the number of scripts in the returned array (or zero if None is returned).

Most languages use only one script for writing, but there are some that use two (Latin and Cyrillic for example), and a few use three (Japanese for example). Applications should not make any assumptions on the maximum number of scripts returned though, except that it is positive if the return value is not None, and it is a small number.

The includes_script() function uses this function internally.

Note: while the return value is declared as PangoScript, the returned values are from the GUnicodeScript enumeration, which may have more values. Callers need to handle unknown values.

Returns

An array of Script values, with the number of entries in the array stored in num_scripts, or None if Pango does not have any information about this particular language tag (also the case if self is None). The returned array is owned by Pango and should not be modified or freed.

pub fn sample_string(&self) -> GString

Get a string that is representative of the characters needed to render a particular language.

The sample text may be a pangram, but is not necessarily. It is chosen to be demonstrative of normal text in the language, as well as exposing font feature requirements unique to the language. It is suitable for use as sample text in a font selection dialog.

If self is None, the default language as found by default() is used.

If Pango does not have a sample string for self, the classic “The quick brown fox…” is returned. This can be detected by comparing the returned pointer value to that returned for (non-existent) language code “xx”. That is, compare to: <informalexample>``<programlisting> pango_language_get_sample_string (pango_language_from_string (“xx”)) </programlisting>``</informalexample>

Returns

the sample string. This value is owned by Pango and should not be freed.

Trait Implementations

impl Default for Language

fn default() -> Self

Returns the “default value” for a type.