deeplx 2.2.6

A Rust package for unlimited DeepL translation
Documentation 
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

//! `deeplx` is a Rust package for unlimited DeepL translation.
//!
//! # Overview
//!
//! `deeplx` provides a convenient interface for interacting with DeepL.
//!
//! Proxy support is available on non-wasm32 targets and can be configured via the `proxy` field of [`Config`].
//! On wasm32 targets, the `proxy` field is not available due to platform limitations.
//!
//! Translations can be performed in either 'Free' or 'Pro' mode, depending on whether a DeepL session cookie is provided.
//!
//! The core structure of this library is [`DeepLX`], through which you can:
//! - Create a new translation client instance using [`DeepLX::new`].
//! - Perform text translations with [`DeepLX::translate`], automatically detecting the source language if needed, and retrieving both a primary translation and multiple alternative translations.
//!
//! In addition, the library defines several data structures for representing requests and responses from DeepL's API, ensuring consistency with [OwO-Network/DeepLX](https://github.com/OwO-Network/DeepLX):
//! - [`DeepLXTranslationResult`]: Represents the translation result including status code, source and target languages, translated text, and any alternative translations.
//!
//! By maintaining consistency with the [OwO-Network/DeepLX](https://github.com/OwO-Network/DeepLX),
//! this project aims to provide a familiar and straightforward experience for users looking to integrate DeepL translations into their Rust applications.
//!
//! # Example
//!
//! ## Basic usage
//!
//! ```no_run
//! use deeplx::{Config, DeepLX};
//!
//! async fn run() {
//!     let translator = DeepLX::new(Config::default());
//!     match translator
//!         .translate("auto", "zh", "Hello, world!", None)
//!         .await
//!     {
//!         Ok(res) => println!("Translated: {}", res.data),
//!         Err(e) => eprintln!("{}", e),
//!     }
//! }
//!
//! #[cfg(not(target_arch = "wasm32"))]
//! #[tokio::main]
//! async fn main() {
//!    run().await;
//! }
//!
//! #[cfg(target_arch = "wasm32")]
//! #[tokio::main(flavor = "current_thread")]
//! async fn main() {
//!    run().await;
//! }
//! ```
//!
//! ## Using a proxy (non-wasm32 only)
//!
//! ```no_run
//! use deeplx::{Config, DeepLX};
//!
//! #[cfg(not(target_arch = "wasm32"))]
//! async fn run_with_proxy() {
//!     let translator = DeepLX::new(Config {
//!         proxy: Some("http://pro.xy".to_string()),
//!         ..Default::default()
//!     });
//!     match translator
//!         .translate("auto", "zh", "Hello, world!", None)
//!         .await
//!     {
//!         Ok(res) => println!("Translated: {}", res.data),
//!         Err(e) => eprintln!("{}", e),
//!     }
//! }
//! ```
#![cfg_attr(docsrs, feature(doc_cfg))]

mod skeleton;

pub use skeleton::{
    data::DeepLXTranslationResult,
    error::Error,
    translate::{Config, DeepLX},
};