Struct detect_lang::Language

pub struct Language<'a>(pub &'a str, pub &'a str);

Languages contain a name and an ID (Language(name, id)).

Methods

impl<'a> Language<'a>

pub fn name(&self) -> &'a str

Returns the name of the language.

Example

assert_eq!(from_path("foo.rs").unwrap().name(), "Rust");
assert_eq!(from_path("foo.md").unwrap().name(), "Markdown");

assert_eq!(from_extension("rs").unwrap().name(), "Rust");
assert_eq!(from_extension("md").unwrap().name(), "Markdown");

// The case is ignored
assert_eq!(from_path("foo.jSoN").unwrap().name(), "JSON");
assert_eq!(from_extension("jSoN").unwrap().name(), "JSON");

pub fn id(&self) -> &'a str

Returns the ID of the language. In most cases the language ID is just a lowercase version of the name.

The ID is also usable as a URL slug.

Example

assert_eq!(from_path("foo.rs").unwrap().id(), "rust");
assert_eq!(from_path("foo.md").unwrap().id(), "markdown");

assert_eq!(from_extension("rs").unwrap().id(), "rust");
assert_eq!(from_extension("md").unwrap().id(), "markdown");

// The case is ignored
assert_eq!(from_path("foo.jSoN").unwrap().id(), "json");
assert_eq!(from_extension("jSoN").unwrap().id(), "json");

Trait Implementations

impl<'a> Clone for Language<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for Language<'a>

impl<'a> Debug for Language<'a>

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

Formats the value using the given formatter.

impl<'a> Deref for Language<'a>

type Target = str

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a> Eq for Language<'a>

impl<'a> Hash for Language<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<'a> Ord for Language<'a>

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

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<'a> PartialEq<Language<'a>> for Language<'a>

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Language<'a>) -> bool

This method tests for !=.

impl<'a> PartialOrd<Language<'a>> for Language<'a>

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

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

fn lt(&self, other: &Language<'a>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Language<'a>) -> bool

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

fn gt(&self, other: &Language<'a>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Language<'a>) -> bool

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

impl<'a> StructuralEq for Language<'a>

impl<'a> StructuralPartialEq for Language<'a>