Struct Yandex

pub struct Yandex<'a> { /* private fields */ }

Yandex Translate API

A struct representing the Yandex Translate API.

This API needs a key, which can be provided at this page.

It implements:

• language translation, with the default Api trait
• language detection, with the ApiDetect trait
• API key, with the ApiKey trait

To use it, first construct the struct with a defined API key, then do the desired function calls.

Examples

Important: In order to use those examples, you need to get a free API Key on the Yandex website and replace the YANDEX_API_KEY const with it.

Text translation

Translate a text from an unknown language to Japanese:

use text_translator::*;

// set your personnal API key
const YANDEX_API_KEY: &str = "trnsl.1.1.20200507T202428Z.5e03932d06f63e6a.6ca69498c3b22bff94f6eda9ad8c21b4c3320078";

// construct the struct
let translator: Yandex = Yandex::with_key(YANDEX_API_KEY);

let text: String = "Hello, my name is Naruto Uzumaki!".to_string();

// translate the text, returns a `Result<String, Error>`
let translated_text: String = match translator.translate(text, InputLanguage::Automatic, Language::Japanese) {
    Ok(result) => result,
    Err(err) => panic!("API error, could not translate text : {:#?}", err)
};

assert_eq!(translated_text, "こんにちは、鳴門のうずまき!")

Language detection

Detect the language of a text:

use text_translator::*;

const YANDEX_API_KEY: &str = "trnsl.1.1.20200507T202428Z.5e03932d06f63e6a.6ca69498c3b22bff94f6eda9ad8c21b4c3320078";

let translator: Yandex = Yandex::with_key(YANDEX_API_KEY);
let text: String = "Bonjour, je m'appelle Naruto Uzumaki!".to_string();

// detect the language, returns a `Result<Option<Language>, Error>`
let detected_language: Language = match translator.detect(text) {
    Ok(response) => match response {
        Some(language) => language,
        None => panic!("Could detect language : unknown language"),
    },
    Err(err) => panic!("API error, could not detect language : {:#?}", err)
};

assert_eq!(detected_language, Language::French)

Implementations

impl<'a> Yandex<'a>

pub const fn with_key(key: &'a str) -> Self

Returns a new Yandex struct with the given API key.

Can be used in constant definitions.

Trait Implementations

impl<'a> Api for Yandex<'a>

fn new() -> Self

Returns a new Yandex struct without API key.

To set it, use with_key or set_key methods instead.

fn translate( &self, text: String, source_language: InputLanguage, target_language: Language, ) -> Result<String, Error>

Translates text between two languages.

impl<'a> ApiDetect for Yandex<'a>

fn detect(&self, text: String) -> Result<Option<Language>, Error>

Detect the language of the selected text.

impl<'a> ApiKey<'a> for Yandex<'a>

fn set_set(&mut self, key: &'a str)

fn get_key(&self) -> Option<&'a str>

impl<'a> Clone for Yandex<'a>

fn clone(&self) -> Yandex<'a>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for Yandex<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> Ord for Yandex<'a>

fn cmp(&self, other: &Yandex<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'a> PartialEq for Yandex<'a>

fn eq(&self, other: &Yandex<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialOrd for Yandex<'a>

fn partial_cmp(&self, other: &Yandex<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> Copy for Yandex<'a>

impl<'a> Eq for Yandex<'a>

impl<'a> StructuralPartialEq for Yandex<'a>