Permalink
Switch branches/tags
Nothing to show
Find file
Fetching contributors…
Cannot retrieve contributors at this time
210 lines (70 sloc) 4.39 KB

#Module i18n_collation#

Copyright (c) 2010-2011 Michael Uvarov

Authors: Michael Uvarov (arcusfelis@gmail.com).

##Data Types##

###i18n_collation_option()##

i18n_collation_option() = primary | secondary | tertiary | quantiary | identical | shifted | non_ignorable | lower_first | upper_first | numeric | french_accents | hiragana | normalization

###i18n_collator()##

i18n_collator() = resource()

###i18n_compare_result()##

i18n_compare_result() = less | equal | greater

###i18n_locale_id()##

i18n_locale_id() = atom()

###i18n_sort_key()##

i18n_sort_key() = binary()

###i18n_string()##

i18n_string() = binary()

###resource()##

resource() = <<>>

##Function Index##

available_locales/0
compare/3
map_sort/2Sort a list.
open/0
open/1
open/2
open_rules/1Get a rules-based collator.
open_rules/2Get a rule-based collator with options.
sort/2
sort_key/2

##Function Details##

###available_locales/0##

available_locales() -> [i18n_locale_id()]



###compare/3##

compare(C::i18n_collator(), S1::i18n_string(), S2::i18n_string()) -> i18n_compare_result()



###map_sort/2##

map_sort(F::function(), Xx::[any()]) -> [any()]



Sort a list.

Xx is a list of strings to sort. F produces a sort keys.

###open/0##

open() -> i18n_collator()



###open/1##

open(L::i18n_locale_id()) -> i18n_collator()



###open/2##

open(L::i18n_locale_id(), Options::[i18n_collation_option()]) -> i18n_collator()



###open_rules/1##

open_rules(Rules::i18n_string()) -> i18n_collator()



Get a rules-based collator.

###open_rules/2##

open_rules(Rules::i18n_string(), Options::[i18n_collation_option()]) -> i18n_collator()



Get a rule-based collator with options. More information

###sort/2##

sort(C::i18n_collator(), Ss::[i18n_string()]) -> [i18n_string()]



###sort_key/2##

sort_key(C::i18n_collator(), S::i18n_string()) -> i18n_sort_key()