Struct Language

pub struct Language {
    pub name: &'static str,
    pub language_type: LanguageType,
    pub color: Option<&'static str>,
    pub group: Option<&'static str>,
}

The language struct that contains the name and other interesting information about a language.

Examples

use hyperpolyglot::{Language, LanguageType};
use std::convert::TryFrom;

let language = Language::try_from("Rust").unwrap();
let expected = Language {
    name: "Rust",
    language_type: LanguageType::Programming,
    color: Some("#dea584"),
    group: None,
};
assert_eq!(language, expected)

Errors

try_from will error if the langauge name is not one of the known languages

If try_from is called with a language returned from detect or get_language_breakdown the value is guaranteed to be there and can be unwrapped

Fields

name: &'static str

The name of the language

language_type: LanguageType

Type of language. ex/ Data, Programming, Markup, Prose

color: Option<&'static str>

The css hex color used to represent the language on github. ex/ #dea584

group: Option<&'static str>

Name of the parent language. ex/ The group for TSX would be TypeScript

Trait Implementations

impl Clone for Language

fn clone(&self) -> Language

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Language

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

Formats the value using the given formatter.

impl PartialEq for Language

fn eq(&self, other: &Language) -> 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 TryFrom<&str> for Language

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(name: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Language

impl Eq for Language

impl StructuralPartialEq for Language