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
//! # libretranslate-rs
//!! [![Crates.io](https:img.shields.io/crates/v/libretranslate.svg)](https://crates.io/crates/libretranslate)
//! [![Crates.io](https://img.shields.io/crates/d/libretranslate)](https://crates.io/crates/libretranslate)
//! [![API](https://docs.rs/libretranslate/badge.svg)](https://docs.rs/libretranslate)
//! [![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/grantshandy/libretranslate-rs)
//! ![GitHub Workflow Status](https://img.shields.io/github/workflow/status/grantshandy/libretranslate-rs/Rust)
//!
//! A LibreTranslate API client for Rust.
//! ```
//! libretranslate = "0.5"
//! ```
//!
//! `libretranslate` allows you to use open source machine translation in your projects through an easy to use API that connects to the official [webpage](https://libretranslate.com/).
//!
//! ## Basic Example
//! `libretranslate` is an async library, so you'll have to use an async runtime like [`tokio`](https://crates.io/crates/tokio) or [`async-std`](https://crates.io/crates/async-std).
//!
//! All translations are done through the [`translate`](crate::translate) function:
//! ```rust
//! use libretranslate::{translate, Language};
//!
//! #[tokio::main]
//! async fn main() {
//! let source = Language::French;
//! let target = Language::English;
//! let input = "Le texte français.";
//!
//! let data = translate(source, target, input, None).await.unwrap();
//!
//! println!("Input {}: {}", data.source.as_pretty(), data.input);
//! println!("Output {}: {}", data.target.as_pretty(), data.output);
//! }
//! ```
//!
//! Output:
//! ```
//! Input French: le texte français.
//! Output English: the French text.
//! ```
//!
//! [See In Examples Folder](https://github.com/grantshandy/libretranslate-rs/blob/main/examples/basic.rs)
//!
//! ## Language Detection
//! Here's a simple example.
//! ```rust
//! use libretranslate::{translate, Language};
//!
//! #[tokio::main]
//! async fn main() {
//! let target = Language::English;
//! let text = "le texte français.";
//!
//! let data = translate(Language::Detect, target, text, None).await.unwrap();
//!
//! println!("Input {}: {}", data.source.as_pretty(), data.input);
//! println!("Output {}: {}", data.target.as_pretty(), data.output);
//! }
//! ```
//!
//! Output:
//! ```
//! Input French: le texte français.
//! Output English: the French text.
//! ```
//!
//! [See In Examples Folder](https://github.com/grantshandy/libretranslate-rs/blob/main/examples/detect.rs)
//!
//! ## Language Functionality
//! The `Language` enum has a lot of functionality so you can create a `Language` from all sorts of different user inputs.
//!
//! You can return a `&str` with the language's name in English using `as_pretty()`, or the language's code using `as_code()`.
//!
//! `Language` also implements `FromStr` so you can create a `Language` using text like "en", or "English" (case doesn't matter). You can do this by either using `Language::from()` or `.parse::<Language>()`.
//!
//! Here's a simple example.
//! ```rust
//! let lang = Language::English;
//! let lang_parse = "english".parse::<Language>().unwrap();
//!
//! assert_eq!(lang, lang_parse);
//! assert_eq!("en", lang.as_code());
//! assert_eq!("English", lang.as_pretty());
//! ```
//!
//! [See In Examples Folder](https://github.com/grantshandy/libretranslate-rs/blob/main/examples/language.rs)
//!
//! ## String Methods
//! The trait `Translate` implements [`AsRef<str>`](https://doc.rust-lang.org/std/convert/trait.AsRef.html), meaning that any `&str` or `String` can be translated into any other language.
//!
//! Here's a simple example.
//! ```rust
//! use libretranslate::{Language, Translate};
//!
//! #[tokio::main]
//! async fn main() {
//! let text = "This is text, written on a computer, in English."
//! .to_lang(Language::German)
//! .from_lang(Language::English)
//! .translate()
//! .await
//! .unwrap();
//!
//! println!("output: \"{}\"", text);
//! }
//! ```
//!
//! Output:
//! ```
//! Output: "Dies ist Text, geschrieben auf einem Computer, in Englisch."
//! ```
//!
//! [See In Examples Folder](https://github.com/grantshandy/libretranslate-rs/blob/main/examples/method.rs)
//!
//! ## Available Languages
//! - English
//! - Arabic
//! - Chinese
//! - French
//! - German
//! - Italian
//! - Japanese
//! - Portuguese
//! - Russian
//! - Spanish
//! - Polish
//!
use serde_json::Value;
/// Data that is output by the [`translate`](translate) function.
#[derive(Debug, Clone, PartialEq, Hash)]
pub struct Translation {
pub url: String,
pub source: Language,
pub target: Language,
pub input: String,
pub output: String,
}
/// Translate text between two [`Language`](Language).
pub async fn translate<T: AsRef<str>>(
source: Language,
target: Language,
input: T,
key: Option<T>,
) -> Result<Translation, TranslateError> {
let url = "https://libretranslate.com/";
let key: Option<String> = key.map(|data| data.as_ref().to_string());
let data = translate_url(source, target, input.as_ref(), url, key).await?;
Ok(data)
}
/// Translate using a custom URL.
pub async fn translate_url<T: AsRef<str>>(
source: Language,
target: Language,
input: T,
url: T,
key: Option<String>,
) -> Result<Translation, TranslateError> {
let complete_url: String;
if url.as_ref().ends_with('/') {
complete_url = format!("{}translate", url.as_ref());
} else {
complete_url = format!("{}/translate", url.as_ref());
};
if input.as_ref().chars().count() >= 5000 {
return Err(TranslateError::LengthError);
};
let data: Value = match key {
Some(key) => {
serde_json::json!({
"q": input.as_ref(),
"source": source.as_code(),
"target": target.as_code(),
"api_key": key,
})
}
None => {
serde_json::json!({
"q": input.as_ref(),
"source": source.as_code(),
"target": target.as_code(),
})
}
};
let body = match surf::http::Body::from_json(&data) {
Ok(data) => data,
Err(error) => return Err(TranslateError::HttpError(error.to_string())),
};
let url = complete_url.clone();
let res = match surf::post(complete_url).body(body).recv_string().await {
Ok(data) => data,
Err(error) => return Err(TranslateError::HttpError(error.to_string())),
};
let parsed_json: Value = match serde_json::from_str(&res) {
Ok(parsed_json) => parsed_json,
Err(error) => {
return Err(TranslateError::ParseError(error.to_string()));
}
};
if let Value::String(error) = &parsed_json["error"] {
return Err(TranslateError::ParseError(error.to_string()));
}
let output = match &parsed_json["translatedText"] {
Value::String(output) => output,
_ => {
return Err(TranslateError::ParseError(String::from(
"Unable to find translatedText in parsed JSON",
)))
}
};
let input = input.as_ref().to_string();
let output = output.to_string();
Ok(Translation {
url,
source,
target,
input,
output,
})
}
use std::str::FromStr;
/// Languages that can used for input and output of the [`translate`](crate::translate) function.
#[derive(Debug, Clone, PartialEq, Copy, Hash)]
pub enum Language {
Detect,
English,
Arabic,
Chinese,
French,
German,
Italian,
Japanese,
Portuguese,
Russian,
Spanish,
Polish,
}
impl Language {
/// Return the language with the language code name. (ex. "ar", "de")
pub fn as_code(&self) -> &'static str {
match self {
Language::Detect => "auto",
Language::English => "en",
Language::Arabic => "ar",
Language::Chinese => "zh",
Language::French => "fr",
Language::German => "de",
Language::Italian => "it",
Language::Japanese => "ja",
Language::Portuguese => "pt",
Language::Russian => "ru",
Language::Spanish => "es",
Language::Polish => "pl",
}
}
/// Return the Language with the full English name. (ex. "Arabic", "German")
pub fn as_pretty(&self) -> &'static str {
match self {
Language::Detect => "Detected",
Language::English => "English",
Language::Arabic => "Arabic",
Language::Chinese => "Chinese",
Language::French => "French",
Language::German => "German",
Language::Italian => "Italian",
Language::Japanese => "Japanese",
Language::Portuguese => "Portuguese",
Language::Russian => "Russian",
Language::Spanish => "Spanish",
Language::Polish => "pl",
}
}
/// Create a Language from &str like "en" or "French". Case Doesn't matter.
pub fn from<T: AsRef<str>>(s: T) -> Result<Self, LanguageError> {
return Self::from_str(s.as_ref());
}
/// Create a Language from a [`LanguageIdentifier`](unic_langid::LanguageIdentifier).
#[cfg(feature = "unicode_langid")]
pub fn from_unic_langid(s: unic_langid::LanguageIdentifier) -> Result<Self, LanguageError> {
match s.language.as_str() {
"en" => Ok(Language::English),
"ar" => Ok(Language::Arabic),
"zh" => Ok(Language::Chinese),
"fr" => Ok(Language::French),
"de" => Ok(Language::German),
"it" => Ok(Language::Italian),
"pt" => Ok(Language::Portuguese),
"ru" => Ok(Language::Russian),
"es" => Ok(Language::Spanish),
"ja" => Ok(Language::Japanese),
"pl" => Ok(Language::Polish),
&_ => Err(LanguageError::FormatError("Unknown Language".to_string())),
}
}
}
// TODO: Get locale from user to set Language::default().
impl Default for Language {
fn default() -> Self {
Language::English
}
}
impl FromStr for Language {
type Err = LanguageError;
fn from_str(s: &str) -> Result<Self, Self::Err> {
match s.to_string().to_lowercase().as_str() {
"en" => Ok(Language::English),
"ar" => Ok(Language::Arabic),
"zh" => Ok(Language::Chinese),
"fr" => Ok(Language::French),
"de" => Ok(Language::German),
"it" => Ok(Language::Italian),
"pt" => Ok(Language::Portuguese),
"ru" => Ok(Language::Russian),
"es" => Ok(Language::Spanish),
"ja" => Ok(Language::Japanese),
"pl" => Ok(Language::Polish),
"english" => Ok(Language::English),
"arabic" => Ok(Language::Arabic),
"chinese" => Ok(Language::Chinese),
"french" => Ok(Language::French),
"german" => Ok(Language::German),
"italian" => Ok(Language::Italian),
"portuguese" => Ok(Language::Portuguese),
"russian" => Ok(Language::Russian),
"spanish" => Ok(Language::Spanish),
"japanese" => Ok(Language::Japanese),
"polish" => Ok(Language::Polish),
"auto" => Ok(Language::Detect),
&_ => Err(LanguageError::FormatError(s.to_string())),
}
}
}
impl std::fmt::Display for Language {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
match self {
Language::Detect => write!(f, "auto"),
Language::English => write!(f, "en"),
Language::Arabic => write!(f, "ar"),
Language::Chinese => write!(f, "zh"),
Language::French => write!(f, "fr"),
Language::German => write!(f, "de"),
Language::Italian => write!(f, "it"),
Language::Portuguese => write!(f, "pt"),
Language::Russian => write!(f, "ru"),
Language::Spanish => write!(f, "es"),
Language::Japanese => write!(f, "ja"),
Language::Polish => write!(f, "pl"),
}
}
}
/// Errors that could be outputed by a [`Language`](Language).
#[derive(Debug, Clone, PartialEq, Hash)]
pub enum LanguageError {
FormatError(String),
}
impl std::error::Error for LanguageError {}
impl std::fmt::Display for LanguageError {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
match self {
LanguageError::FormatError(error) => {
write!(f, "Unknown Language: {}", error)
}
}
}
}
/// Errors that could be outputed by [`translate`](crate::translate).
#[derive(Debug, Clone, PartialEq, Hash)]
pub enum TranslateError {
HttpError(String),
ParseError(String),
DetectError,
LengthError,
}
impl std::error::Error for TranslateError {}
impl std::fmt::Display for TranslateError {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
match self {
TranslateError::HttpError(error) => {
write!(f, "HTTP request error: {}", error.to_string())
}
TranslateError::ParseError(error) => {
write!(f, "JSON parsing error: {}", error.to_string())
}
TranslateError::DetectError => {
write!(f, "Language detection error")
}
TranslateError::LengthError => {
write!(f, "Requested text is too long")
}
}
}
}
/// A struct created by a [`Translate`](Translate) that can be translated using the translate method.
pub struct Query<'a> {
pub url: &'a str,
pub text: &'a str,
pub source: Language,
pub target: Language,
}
impl<'a> Query<'a> {
pub fn to_lang(mut self, language: Language) -> Query<'a> {
self.target = language;
self
}
pub fn from_lang(mut self, language: Language) -> Query<'a> {
self.source = language;
self
}
pub fn url(mut self, url: &'a str) -> Query {
self.url = url;
self
}
pub async fn translate(self) -> Result<String, TranslateError> {
let res = crate::translate_url(self.source, self.target, self.text, self.url, None).await?;
Ok(res.output)
}
}
/// Translate text from a [`String`](std::string::String) or [`str`](std::str) (anything that implements [`AsRef<str>`](std::convert::AsRef)).
pub trait Translate {
fn to_lang(&self, language: Language) -> Query;
fn from_lang(&self, language: Language) -> Query;
}
impl<T> Translate for T
where
T: AsRef<str>,
{
fn to_lang(&self, language: Language) -> Query {
Query {
url: "https://libretranslate.com/",
text: self.as_ref(),
source: Language::Detect,
target: language,
}
}
fn from_lang(&self, language: Language) -> Query {
Query {
url: "https://libretranslate.com/",
text: self.as_ref(),
source: language,
target: Language::default(),
}
}
}
/// Build Translations more verbosely.
#[derive(Debug, Clone, PartialEq, Hash)]
pub struct TranslationBuilder {
pub url: String,
pub source: Language,
pub target: Language,
pub input: String,
key: Option<String>,
}
impl TranslationBuilder {
pub fn new() -> Self {
Self {
url: String::from("https://libretranslate.com/"),
source: Language::Detect,
target: Language::default(),
input: String::new(),
key: None,
}
}
pub fn url<T: AsRef<str>>(mut self, url: T) -> Self {
self.url = url.as_ref().to_string();
self
}
pub fn from_lang(mut self, lang: Language) -> Self {
self.source = lang;
self
}
pub fn to_lang(mut self, lang: Language) -> Self {
self.target = lang;
self
}
pub fn text<T: AsRef<str>>(mut self, text: T) -> Self {
self.input = text.as_ref().to_string();
self
}
pub fn key<T: AsRef<str>>(mut self, key: T) -> Self {
self.key = Some(key.as_ref().to_string());
self
}
pub async fn translate(mut self) -> Result<Translation, TranslateError> {
if self.input.is_empty() {
return Ok(Translation {
url: self.url,
source: self.source,
target: self.target,
input: self.input,
output: String::new(),
});
};
let data = translate_url(
self.source,
self.target,
self.input.clone(),
self.url.clone(),
self.key,
)
.await?;
self.source = data.source;
self.target = data.target;
Ok(Translation {
url: self.url,
source: self.source,
target: self.target,
input: self.input,
output: data.output,
})
}
}
impl Default for TranslationBuilder {
fn default() -> Self {
Self::new()
}
}