Define a language enum.

Author: artob

README.md

@@ -48,7 +48,7 @@ tldr = { version = "0", package = "tldr-traits", default-features = false, featu
 ### Importing the Library
 
 ```rust,ignore
-use tldr::{Tldr, TldrContext, TldrResult, TldrSummary, ToTldr};
+use tldr::{Tldr, TldrContext, TldrLanguage, TldrResult, TldrSummary, ToTldr};
 ```
 
 ### Implementing the Trait
@@ -72,6 +72,7 @@ impl Tldr for Rectangle {
 
 - [`Tldr`](#tldr)
 - [`TldrContext`](#tldrcontext)
+- [`TldrLanguage`](#tldrlanguage)
 - [`TldrResult`](#tldrresult)
 - [`TldrSummary`](#tldrsummary)
 - [`ToTldr`](#totldr)
@@ -92,9 +93,20 @@ pub trait Tldr<T = String> {
 
 ### [`TldrContext`]
 
-```rust
+```rust,ignore
 pub struct TldrContext {
-    pub language: String,
+    pub language: TldrLanguage,
+}
+```
+
+### [`TldrLanguage`]
+
+```rust,ignore
+pub enum TldrLanguage {
+    #[default]
+    English,
+    // ...
+    Other(String),
 }
 ```
 
@@ -148,6 +160,7 @@ git clone https://github.com/dryrust/tldr.rs.git
 
 [`Tldr`]: https://docs.rs/tldr-traits/latest/tldr_traits/trait.Tldr.html
 [`TldrContext`]: https://docs.rs/tldr-traits/latest/tldr_traits/struct.TldrContext.html
+[`TldrLanguage`]: https://docs.rs/tldr-traits/latest/tldr_traits/enum.TldrLanguage.html
 [`TldrResult`]: https://docs.rs/tldr-traits/latest/tldr_traits/type.TldrResult.html
 [`TldrSummary`]: https://docs.rs/tldr-traits/latest/tldr_traits/struct.TldrSummary.html
 [`ToTldr`]: https://docs.rs/tldr-traits/latest/tldr_traits/trait.ToTldr.html

src/context.rs

@@ -1,19 +1,19 @@
 // This is free and unencumbered software released into the public domain.
 
-use alloc::string::String;
+use crate::TldrLanguage;
 use core::str::FromStr;
 
-#[derive(Clone, Debug, Eq, Hash, PartialEq)]
+#[derive(Clone, Debug, Default, Eq, Hash, PartialEq)]
 pub struct TldrContext {
-    pub language: String, // TODO
+    pub language: TldrLanguage,
 }
 
 impl FromStr for TldrContext {
     type Err = ();
 
     fn from_str(input: &str) -> Result<Self, Self::Err> {
         Ok(TldrContext {
-            language: input.into(),
+            language: input.parse()?,
         })
     }
 }

src/language.rs

@@ -0,0 +1,33 @@
+// This is free and unencumbered software released into the public domain.
+
+use alloc::string::String;
+use core::{fmt, str::FromStr};
+
+#[non_exhaustive]
+#[derive(Clone, Debug, Default, Eq, Hash, PartialEq)]
+pub enum TldrLanguage {
+    #[default]
+    English,
+
+    Other(String),
+}
+
+impl FromStr for TldrLanguage {
+    type Err = ();
+
+    fn from_str(input: &str) -> Result<Self, Self::Err> {
+        Ok(match input {
+            "en" => TldrLanguage::English,
+            _ => TldrLanguage::Other(input.into()),
+        })
+    }
+}
+
+impl fmt::Display for TldrLanguage {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        match self {
+            TldrLanguage::English => write!(f, "en"),
+            TldrLanguage::Other(lang) => write!(f, "{}", lang),
+        }
+    }
+}

src/lib.rs

@@ -14,6 +14,9 @@ extern crate alloc;
 mod context;
 pub use context::*;
 
+mod language;
+pub use language::*;
+
 mod result;
 pub use result::*;