11 releases (7 breaking)

✓ Uses Rust 2018 edition

new 0.8.0 Sep 10, 2019
0.7.0 Jul 31, 2019
0.6.0 Jul 24, 2019
0.4.1 Aug 6, 2018
0.3.0 Oct 15, 2017

#4 in Internationalization (i18n)

Download history 733/week @ 2019-05-28 638/week @ 2019-06-04 976/week @ 2019-06-11 714/week @ 2019-06-18 1185/week @ 2019-06-25 869/week @ 2019-07-02 603/week @ 2019-07-09 684/week @ 2019-07-16 656/week @ 2019-07-23 647/week @ 2019-07-30 689/week @ 2019-08-06 576/week @ 2019-08-13 619/week @ 2019-08-20 574/week @ 2019-08-27 733/week @ 2019-09-03

3,066 downloads per month
Used in 15 crates (3 directly)

Apache-2.0

21KB
242 lines

Fluent Locale

Fluent Locale is a library for language and locale identifier negotiation.

crates.io Build Status Coverage Status

Introduction

This is a Rust implementation of fluent-locale library which is a part of Project Fluent.

The library uses unic-langid and unic-locale to retrieve and operate on Unicde Language and Locale Identifiers. The library provides algorithm for negotiating between lists of locales.

Usage

use fluent_locale::negotiate_languages;
use fluent_locale::NegotiationStrategy;
use fluent_locale::convert_vec_str_to_langids_lossy;
use unic_langid::LanguageIdentifier

// Since langid parsing from string is fallible, we'll use a helper
// function which strips any langids that failed to parse.
let requested = convert_vec_str_to_langids_lossy(&["de-DE", "fr-FR", "en-US"]);
let available = convert_vec_str_to_langids_lossy(&["it", "fr", "de-AT", "fr-CA", "en-US"]);
let default: LanguageIdentifier = "en-US".parse().expect("Parsing langid failed.");

let supported = negotiate_languages(
  &requested,
  &available,
  Some(&default),
  NegotiationStrategy::Filtering
);

let expected = convert_vec_str_to_langids_lossy(&["de-AT", "fr", "fr-CA", "en-US"]);
assert_eq!(supported,
            expected.iter().map(|t| t.as_ref()).collect::<Vec<&LanguageIdentifier>>());

See docs.rs for more examples.

Status

The implementation is in early stage, but is complete according to fluent-locale corpus of tests, which means that it parses, serializes and negotiates as expected.

The negotiation methods can operate on lists of LanguageIdentifier or Locale.

The ergonomics of Rust API can be improved, since the fallible nature of language identifier parsing makes operating on lists of them tedious.

The remaining work is on the path to 1.0 is to gain in-field experience of using it, add more tests and ensure that bad input is correctly handled.

Compatibility

The API is based on UTS 35 definition of Unicode Locale Identifier and is aiming to parse and serialize all locale identifiers according to that definition.

Note: Unicode Locale Identifier is similar, but different, from what BCP47 specifies under the name Language Tag. For most locale management and negotiation needs, the Unicode Locale Identifier used in this crate is likely a better choice, but in some case, like HTTP Accepted Headers, you may need the complete BCP47 Language Tag implementation which this crate does not provide.

Language negotiation algorithms are custom Project Fluent solutions, based on RFC4647.

The language negotiation strategies aim to replicate the best-effort matches with the most limited amount of data. The algorithm returns reasonable results without any database, but the results can be improved with either limited or full CLDR likely-subtags database.

The result is a balance chosen for Project Fluent and may differ from other implementations of language negotiation algorithms which may choose different tradeoffs.

Alternatives

Although Fluent Locale aims to stay close to W3C Accepted Languages, it does not aim to implement the full behavior and some aspects of the language negotiation strategy recommended by W3C, such as weights, are not a target right now.

For such purposes, rust-language-tags crate seems to be a better choice.

Performance

There has not been a significant performance work being done on the library yet, so we expect there are some low hanging fruit waiting for someone to find them.

At the moment performance is comparable to previously mentioned language-tags crate for parsing a sample list of language tags based on this crate's benchmark code:

running 2 tests
test bench_locale(fluent-locale)  ... bench:       1,773 ns/iter (+/- 48)
test bench_locale(language-tags) ... bench:       1,982 ns/iter (+/- 280)

Develop

cargo build
cargo test
cargo bench

Dependencies

~37KB