Integrate with Bon.

Author: artob

Cargo.lock

@@ -18,16 +18,20 @@ publish = true
 
 [features]
 default = ["all", "std"]
-all = ["serde"]
-std = ["serde?/std"]
+all = ["builder", "serde"]
+std = ["bon?/std", "serde?/std"]
 unstable = []
 
 # Optional features:
+builder = ["dep:bon"]
 serde = ["dep:serde"]
 
 [dependencies]
 
 # Optional dependencies:
+bon = { version = "3.6", default-features = false, features = [
+    "alloc",
+], optional = true }
 serde = { version = "1", default-features = false, features = [
     "alloc",
     "derive",

Cargo.toml

@@ -3,10 +3,19 @@
 use crate::TldrLanguage;
 use core::str::FromStr;
 
+/// ```rust
+/// # use tldr_traits::TldrContext;
+/// let context = TldrContext::builder()
+///     .language("en")
+///     .build();
+/// ```
 #[derive(Clone, Debug, Default, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "builder", derive(bon::Builder))]
+#[cfg_attr(feature = "builder", builder(on(TldrLanguage, into)))]
 #[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
 #[cfg_attr(feature = "serde", serde(default))]
 pub struct TldrContext {
+    #[cfg_attr(feature = "builder", builder(default))]
     pub language: TldrLanguage,
 }
 

src/context.rs

@@ -3,6 +3,10 @@
 use alloc::string::String;
 use core::{fmt, str::FromStr};
 
+/// ```rust
+/// # use tldr_traits::TldrLanguage;
+/// let language = TldrLanguage::English;
+/// ```
 #[non_exhaustive]
 #[derive(Clone, Debug, Default, Eq, Hash, PartialEq)]
 #[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
@@ -14,6 +18,15 @@ pub enum TldrLanguage {
     Other(String),
 }
 
+impl From<&str> for TldrLanguage {
+    fn from(input: &str) -> Self {
+        match input {
+            "en" => TldrLanguage::English,
+            _ => TldrLanguage::Other(input.into()),
+        }
+    }
+}
+
 impl FromStr for TldrLanguage {
     type Err = ();
 

src/language.rs

@@ -4,9 +4,24 @@ use crate::{Tldr, TldrContext, TldrResult, ToTldr};
 use alloc::{boxed::Box, string::String};
 use core::fmt::Debug;
 
+/// ```rust
+/// # use tldr_traits::TldrSummary;
+/// let summary: TldrSummary<String> = TldrSummary::builder()
+///     .who("John")
+///     .what("a book")
+///     .when("yesterday")
+///     .r#where("the library")
+///     .why("to learn")
+///     .whence("from the internet")
+///     .how("by reading")
+///     .build();
+/// ```
+///
 /// See: https://en.wikipedia.org/wiki/Five_Ws
 /// See: https://en.wikipedia.org/wiki/Interrogative_word
 #[derive(Clone, Debug, Default)]
+#[cfg_attr(feature = "builder", derive(bon::Builder))]
+#[cfg_attr(feature = "builder", builder(on(T, into)))]
 #[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
 #[cfg_attr(feature = "serde", serde(default))]
 pub struct TldrSummary<T: Clone + Debug + Default = String> {