1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626
//! ISO 639 language codes
//!
//! When dealing with different language inputs and APIs, different standards are used to identify
//! a language. Converting between these in an automated way can be tedious. This crate provides an
//! enum which supports conversion from 639-1 and 639-3 and also into these formats, as well as
//! into their names. The English name can be retrieved using
//! [`Language::to_name()`](enum.Language.html#method.to_name) if compiled with the `english_names`
//! feature.
//! The autonyms (local names) can be retrieved using
//! [`to_autonym()`](enum.Language.html#method.to_autonym) if compiled with the `local_names`
//! feature.
//!
//! The language table is compiled into the library. While this increases the binary size, it means
//! that no additional time is wasted on program startup or on table access for allocating or
//! filling the map. It is hence suitable for retrieval of codes in constraint environments.
//!
//! # Examples
//!
//! ```
//! use isolang::Language;
//! #[cfg(feature = "english_names")]
//! assert_eq!(Language::from_639_1("de").unwrap().to_name(), "German");
//! #[cfg(feature = "local_names")]
//! assert_eq!(Language::from_639_1("de").unwrap().to_autonym(), Some("Deutsch"));
//!
//! assert_eq!(Language::from_639_3("spa").unwrap().to_639_1(), Some("es"));
//!
//! #[cfg(feature = "list_languages")]
//! {
//! // Filter languages with a ISO 639-1 code
//! let languages = isolang::languages();
//! let languages_with_iso_639_1 = languages.filter(|language| language.to_639_1().is_some());
//! for language in languages_with_iso_639_1 {
//! assert_eq!(language.to_639_1().is_some(), true);
//! }
//! }
//! ```
#[cfg(feature = "serde")]
mod serde_impl;
extern crate phf;
use std::{
error::Error,
fmt::{Debug, Display, Formatter},
str::{self, FromStr},
};
/// Language data extracted from `iso-639-3.tab` and `iso639-autonyms.tsv`
///
/// Instances of this are generated in the `generated_code_is_fresh()` integration test,
/// which generates the code in `src/isotable.rs`.
struct LanguageData {
/// The ISO-639-3 3-letter language code (column `Id` in `iso-639-3.tab`)
code_3: [u8; 3],
/// The ISO-639-1 2-letter language code, if available (column `Part1` in `iso-639-3.tab`)
code_1: Option<[u8; 2]>,
/// The language's name in English (column `Ref_Name` in `iso-639-3.tab`)
///
/// The code generator removes any parenthesized suffix from the name.
#[cfg(feature = "english_names")]
name_en: &'static str,
/// The language's name in its own language (column `autonym` in `iso639-autonyms.tsv`)
#[cfg(feature = "local_names")]
autonym: Option<&'static str>,
}
#[rustfmt::skip]
mod isotable;
pub use isotable::Language;
use isotable::{OVERVIEW, THREE_TO_THREE, TWO_TO_THREE};
/// Get an iterator of all languages.
///
/// This will return an iterator over all the variants of the [`Language`](enum.Language.html) enum.
/// It is available if compiled with the `list_languages` feature.
///
/// # Examples
///
/// ```
/// let languages = isolang::languages();
///
/// // Display ISO 639-3 code of every language
/// for language in languages {
/// println!("{}", language.to_639_3());
/// }
///
/// // Filter languages with a ISO 639-1 code
/// let languages = isolang::languages();
/// let languages_with_iso_639_1 = languages.filter(|language| language.to_639_1().is_some());
/// for language in languages_with_iso_639_1 {
/// assert_eq!(language.to_639_1().is_some(), true);
/// }
/// ```
#[cfg(any(feature = "list_languages", test))]
pub fn languages() -> impl Iterator<Item = Language> {
OVERVIEW.iter().enumerate().filter_map(|(idx, _)| Language::from_usize(idx))
}
impl Language {
/// Create string representation of this Language as a ISO 639-3 code.
///
/// This method will return the ISO 639-3 code, which consists of three letters.
///
/// # Example
///
/// ```
/// use isolang::Language;
///
/// assert_eq!(Language::Deu.to_639_3(), "deu");
/// ```
pub fn to_639_3(&self) -> &'static str {
// SAFETY: The ISO 639 table has been written to the binary with UTF-8 encoding, hence reading it without checks is safe.
unsafe { str::from_utf8_unchecked(&OVERVIEW[*self as usize].code_3) }
}
/// Create two-letter ISO 639-1 representation of the language.
///
/// This will return a two-letter ISO 639-1 code, if it exists and None otherwise.
/// ISO 639-1 codes are only used for the most common languages.
///
/// # Example
///
/// ```
/// use isolang::Language;
///
/// assert!(Language::Gha.to_639_1().is_none());
/// ```
pub fn to_639_1(&self) -> Option<&'static str> {
// SAFETY: The global state is initialised at load time and filled at compile-time. The
// access happens read-only.
unsafe {
OVERVIEW[*self as usize]
.code_1
.as_ref()
.map(|s| str::from_utf8_unchecked(s))
}
}
/// Get the English name of this language.
///
/// This returns the English name of the language, as defined in the ISO 639 standard. It does
/// not include additional comments, e.g. classification of a macrolanguage, etc. It is
/// available if compiled with the `english_names` feature.
///
/// # Examples
///
/// ```rust
/// use isolang::Language;
///
/// assert_eq!(Language::Spa.to_name(), "Spanish");
/// // macro language
/// assert_eq!(Language::Swa.to_name(), "Swahili");
/// // individual language
/// assert_eq!(Language::Swh.to_name(), "Swahili");
/// ```
#[cfg(feature = "english_names")]
pub fn to_name(&self) -> &'static str {
OVERVIEW[*self as usize].name_en
}
/// Get the ISO code by its English name.
///
/// This returns the ISO code by the given English name of the language string, as defined in
/// the ISO 639 standard. It does not include additional comments, e.g. classification of a
/// macrolanguage, etc. Only available if compiled with the `english_names` feature.
///
/// # Examples
///
/// ```rust
/// use isolang::Language;
///
/// assert_eq!(Language::from_name("Spanish"), Some(Language::Spa));
/// ```
#[cfg(feature = "english_names")]
pub fn from_name(engl_name: &str) -> Option<Self> {
OVERVIEW
.iter()
.enumerate()
.find(|(_, it)| it.name_en == engl_name)
.and_then(|(idx, _)| Language::from_usize(idx))
}
/// Get the ISO code by its lowercase English name.
///
/// This returns the ISO code by the given lowercase English name of the language string, as defined in
/// the ISO 639 standard. It does not include additional comments, e.g. classification of a
/// macrolanguage, etc. Only available if compiled with the `lowercase_names` feature.
///
/// # Examples
///
/// ```rust
/// use isolang::Language;
/// let some_input_name = "spanish"; // maybe "Spanish"
/// assert_eq!(Language::from_name_lowercase(&some_input_name.to_ascii_lowercase()), Some(Language::Spa));
/// ```
#[cfg(all(feature = "english_names", feature = "lowercase_names"))]
pub fn from_name_lowercase(engl_name: &str) -> Option<Self> {
OVERVIEW
.iter()
.enumerate()
.find(|(_, it)| {
it.name_en.to_ascii_lowercase().as_str() == engl_name
})
.and_then(|(idx, _)| Language::from_usize(idx))
}
/// Get all matching ISO codes by a provided English name pattern.
///
/// This returns the matching ISO codes for the provided matcher. The matcher matches all known
/// English language names.
///
/// # Examples
///
/// ```rust
/// use isolang::Language;
///
/// assert!(Language::match_names(|lang| lang.contains("Engl")).count() > 1);
/// ```
#[cfg(feature = "english_names")]
pub fn match_names<F>(matcher: F) -> impl Iterator<Item = Self>
where
F: Fn(&str) -> bool + 'static,
{
OVERVIEW.iter().enumerate().filter_map(move |(idx, it)| {
match matcher(it.name_en) {
true => Language::from_usize(idx),
false => None,
}
})
}
/// Get the autonym of this language
///
/// This returns the native language name (if there is one available). This method is available
/// if compiled with the `local_names` feature.
/// The database for those names is found here https://github.com/bbqsrc/iso639-autonyms
/// and it itself is a collection of several different datasets
///
/// # Examples
///
/// ```rust
/// use isolang::Language;
///
/// assert_eq!(Language::Bul.to_autonym(), Some("български"));
/// assert_eq!(Language::Fra.to_autonym(), Some("français"));
/// ```
#[cfg(feature = "local_names")]
pub fn to_autonym(&self) -> Option<&'static str> {
OVERVIEW[*self as usize].autonym
}
/// Get the ISO code by its autonym (local language name).
///
/// The result is `None` is the autonym wasn't found.
///
/// # Examples
///
/// ```rust
/// use isolang::Language;
///
/// assert_eq!(Language::from_autonym("Deutsch"), Some(Language::Deu));
/// ```
#[cfg(feature = "local_names")]
pub fn from_autonym(autonym: &str) -> Option<Self> {
OVERVIEW
.iter()
.enumerate()
.find(|(_, it)| it.autonym == Some(autonym))
.and_then(|(idx, _)| Language::from_usize(idx))
}
/// Get all matching ISO codes by a provided autonym pattern.
///
/// This returns the matching ISO codes for the provided matcher. It is evaluated against all
/// known autonyms (local language names).
///
/// # Examples
///
/// ```rust
/// use isolang::Language;
///
/// assert_eq!(Language::match_autonyms(|lang| lang.contains("Deutsch")).count(), 1);
/// ```
#[cfg(feature = "local_names")]
pub fn match_autonyms<F>(matcher: F) -> impl Iterator<Item = Self>
where
F: Fn(&str) -> bool + 'static,
{
OVERVIEW.iter().enumerate().filter_map(move |(idx, it)| {
it.autonym.and_then(|autonym| match matcher(autonym) {
true => Language::from_usize(idx),
false => None,
})
})
}
/// Create a Language instance rom a ISO 639-1 code.
///
/// This will return a Language instance if the given string is a valid two-letter language
/// code. For invalid inputs, None is returned.
///
/// # Example
///
/// ```
/// use isolang::Language;
///
/// assert!(Language::from_639_1("de").is_some());
/// assert!(Language::from_639_1("…").is_none());
/// ```
pub fn from_639_1(code: &str) -> Option<Language> {
if code.len() != 2 {
return None;
}
TWO_TO_THREE
.get(code)
.copied()
.and_then(|raw_lang| Language::from_usize(raw_lang as usize))
}
/// Create a Language instance rom a ISO 639-3 code.
///
/// This will return a Language instance if the given string is a valid three-letter language
/// code. For invalid inputs, None is returned.
///
/// # Example
///
/// ```
/// use isolang::Language;
///
/// assert!(Language::from_639_3("dan").is_some());
/// assert!(Language::from_639_1("…").is_none());
/// ```
pub fn from_639_3(code: &str) -> Option<Language> {
if code.len() != 3 {
return None;
}
THREE_TO_THREE
.get(code)
.copied()
.and_then(|raw_lang| Language::from_usize(raw_lang as usize))
}
/// Parse language from given locale
///
/// This parses a language from a given locale string, as used by UNIX-alike and other systems.
///
/// # Example
///
/// ```
/// use isolang::Language;
///
/// assert!(Language::from_locale("de_DE.UTF-8") == Some(Language::Deu));
/// ```
pub fn from_locale(locale: &str) -> Option<Language> {
if locale.len() < 3 {
return None;
}
// use first bit of locale (before the _) to detect the language
locale.split('_').next().and_then(Language::from_639_1)
}
}
#[allow(clippy::derivable_impls)]
impl Default for Language {
fn default() -> Self {
Language::Und
}
}
impl Debug for Language {
fn fmt(&self, f: &mut Formatter) -> std::fmt::Result {
write!(f, "{}", self.to_639_3())
}
}
impl Display for Language {
#[cfg(all(feature = "local_names", feature = "english_names"))]
fn fmt(&self, f: &mut Formatter) -> std::fmt::Result {
write!(
f,
"{} ({})",
self.to_name(),
self.to_autonym().unwrap_or("missing autonym")
)
}
#[cfg(all(feature = "local_names", not(feature = "english_names")))]
fn fmt(&self, f: &mut Formatter) -> std::fmt::Result {
write!(f, "{}", self.to_autonym().unwrap_or("missing autonym"))
}
#[cfg(all(not(feature = "local_names"), feature = "english_names"))]
fn fmt(&self, f: &mut Formatter) -> std::fmt::Result {
write!(f, "{}", self.to_name())
}
#[cfg(all(not(feature = "local_names"), not(feature = "english_names")))]
fn fmt(&self, f: &mut Formatter) -> std::fmt::Result {
write!(f, "{}", self.to_639_3())
}
}
#[derive(Debug)]
pub struct ParseLanguageError(String);
impl Display for ParseLanguageError {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
write!(f, "'{}' is not a valid ISO 639-1 or 639-3 code.", self.0)
}
}
impl Error for ParseLanguageError {}
impl FromStr for Language {
type Err = ParseLanguageError;
#[cfg(any(
not(feature = "english_names"),
not(feature = "lowercase_names")
))]
fn from_str(s: &str) -> Result<Self, ParseLanguageError> {
match Language::from_639_3(s).or_else(|| Language::from_639_1(s)) {
Some(l) => Ok(l),
None => Err(ParseLanguageError(s.to_owned())),
}
}
#[cfg(all(
feature = "english_names",
feature = "lowercase_names",
not(feature = "local_names")
))]
fn from_str(s: &str) -> Result<Self, ParseLanguageError> {
match Language::from_639_3(s)
.or_else(|| Language::from_639_1(s))
.or_else(|| Language::from_name_lowercase(s))
{
Some(l) => Ok(l),
None => Err(ParseLanguageError(s.to_owned())),
}
}
#[cfg(all(
feature = "english_names",
feature = "lowercase_names",
feature = "local_names"
))]
fn from_str(s: &str) -> Result<Self, ParseLanguageError> {
match Language::from_639_3(s)
.or_else(|| Language::from_639_1(s))
.or_else(|| Language::from_name_lowercase(s))
.or_else(|| Language::from_autonym(s))
{
Some(l) => Ok(l),
None => Err(ParseLanguageError(s.to_owned())),
}
}
}
#[cfg(test)]
mod tests {
use super::*;
#[cfg(feature = "serde")]
extern crate serde_json;
use std::fmt::Write;
#[test]
fn invalid_locale_gives_none() {
assert!(Language::from_locale("foo").is_none());
assert!(Language::from_locale("deu_DEU.UTF-8").is_none());
assert!(Language::from_locale("___").is_none());
assert!(Language::from_locale("ää_öö.UTF-8").is_none());
}
#[test]
fn test_valid_locales_are_correctly_decoded() {
assert_eq!(Language::from_locale("de_DE.UTF-8"), Some(Language::Deu));
assert_eq!(Language::from_locale("en_GB.UTF-8"), Some(Language::Eng));
}
#[test]
fn test_std_fmt() {
let mut t = String::new();
write!(t, "{}", Language::Deu).unwrap();
if cfg!(feature = "local_names") && cfg!(feature = "english_names") {
assert_eq!(t, "German (Deutsch)");
} else if cfg!(feature = "local_names") {
assert_eq!(t, "Deutsch");
} else if cfg!(feature = "english_names") {
assert_eq!(t, "German");
} else {
assert_eq!(t, "deu");
}
let mut t = String::new();
write!(t, "{:?}", Language::Deu).unwrap();
assert_eq!(t, "deu");
}
#[test]
#[cfg(feature = "local_names")]
fn test_iso639_3_to_autonym() {
assert_eq!(
Language::from_639_3("bul").unwrap().to_autonym(),
Some("български")
);
assert_eq!(
Language::from_639_3("fra").unwrap().to_autonym(),
Some("français")
);
}
#[test]
fn test_default() {
assert_eq!(Language::default(), Language::Und);
}
#[test]
#[cfg(feature = "serde")]
fn test_serde() {
fn to_json(code: &str) -> String {
format!(r#""{code}""#)
}
fn test_deserialize(language: Language, code: &str) {
assert_eq!(
serde_json::from_str::<Language>(&to_json(code)).unwrap(),
language
);
assert_eq!(
serde_json::from_value::<Language>(serde_json::json!(code))
.unwrap(),
language
);
}
for language in languages() {
assert_eq!(
serde_json::to_string(&language).unwrap(),
to_json(language.to_639_3())
);
test_deserialize(language, language.to_639_3());
if let Some(code) = language.to_639_1() {
test_deserialize(language, code)
}
assert_eq!(
serde_json::from_str::<Language>(
&serde_json::to_string(&language).unwrap()
)
.unwrap(),
language
);
}
assert_eq!(
serde_json::from_str::<Language>(&to_json("foo")).map_err(|e| e.to_string()),
Err("unknown variant `foo`, expected `any valid ISO 639-1 or 639-3 code` at line 1 column 5".to_string())
);
assert_eq!(
serde_json::from_str::<Language>("123").map_err(|e| e.to_string()),
Err("invalid type: integer `123`, expected borrowed str or bytes at line 1 column 3".to_string())
);
}
#[test]
fn test_ordering() {
assert!(Language::Deu < Language::Fra);
let fra = Language::Fra;
assert!(fra <= Language::Fra);
}
#[test]
#[cfg(feature = "list_languages")]
fn test_good_language_filtering() {
let languages = languages();
let languages_with_iso_639_1 =
languages.filter(|language| language.to_639_1().is_some());
for language in languages_with_iso_639_1 {
assert!(language.to_639_1().is_some());
}
}
#[test]
#[cfg(feature = "list_languages")]
fn test_wrong_language_filtering() {
let languages = languages();
let languages_with_iso_639_1 =
languages.filter(|language| language.to_639_1().is_none());
for language in languages_with_iso_639_1 {
assert!(language.to_639_1().is_none());
}
}
#[test]
fn test_from_str() {
assert_eq!(Language::from_str("deu").unwrap(), Language::Deu);
assert_eq!(Language::from_str("fr").unwrap(), Language::Fra);
assert!(Language::from_str("foo").is_err());
}
#[test]
#[cfg(feature = "english_names")]
fn test_from_str_full_features() {
assert_eq!(Language::from_str("es").unwrap().to_name(), "Spanish");
assert_eq!(Language::from_str("spa").unwrap().to_name(), "Spanish");
if cfg!(feature = "lowercase_names") {
assert_eq!(
Language::from_str("spanish").unwrap().to_name(),
"Spanish"
);
}
if cfg!(feature = "lowercase_names") && cfg!(feature = "local_names") {
assert_eq!(
Language::from_str("español").unwrap().to_name(),
"Spanish"
);
}
assert!(Language::from_str("Spanish").is_err());
}
}