Draft some TL;DR abstractions.

Author: artob

README.md

@@ -5,16 +5,20 @@
 [![Package](https://img.shields.io/crates/v/tldr-traits)](https://crates.io/crates/tldr-traits)
 [![Documentation](https://docs.rs/tldr-traits/badge.svg)](https://docs.rs/tldr-traits)
 
-🚧 _We are building in public. This is presently under heavy construction._
+[Rust] abstractions for [TL;DR] summarization.
 
 ## ✨ Features
 
+- Provides the trait [`Tldr`] to generate TL;DR summaries.
+- Provides the trait [`ToTldr`] to convert objects into TL;DR summaries.
+- Supports TL;DR generation for multiple natural languages.
+- Zero required dependencies, only optional integrations.
 - Adheres to the Rust API Guidelines in its [naming conventions].
 - 100% free and unencumbered public domain software.
 
 ## 🛠️ Prerequisites
 
-- [Rust](https://rust-lang.org) 1.85+ (2024 edition)
+- [Rust] 1.85+ (2024 edition)
 
 ## ⬇️ Installation
 
@@ -24,6 +28,20 @@
 cargo add tldr-traits --rename tldr
 ```
 
+### Installation in `Cargo.toml` (with all features enabled)
+
+```toml
+[dependencies]
+tldr = { version = "0", package = "tldr-traits" }
+```
+
+### Installation in `Cargo.toml` (with only specific features enabled)
+
+```toml
+[dependencies]
+tldr = { version = "0", package = "tldr-traits", default-features = false, features = ["serde"] }
+```
+
 ## 👉 Examples
 
 ### Importing the Library
@@ -32,6 +50,52 @@ cargo add tldr-traits --rename tldr
 use tldr::*;
 ```
 
+## 📚 Reference
+
+### [`ToTldr`]
+
+```rust
+pub trait ToTldr {
+    fn to_tldr(&self) -> Box<dyn Tldr>;
+}
+```
+
+### [`Tldr`]
+
+```rust
+pub trait Tldr {
+    fn who(&self, ctx: &TldrContext) -> Option<String>;
+    fn what(&self, ctx: &TldrContext) -> Option<String>;
+    fn when(&self, ctx: &TldrContext) -> Option<String>;
+    fn r#where(&self, ctx: &TldrContext) -> Option<String>;
+    fn why(&self, ctx: &TldrContext) -> Option<String>;
+    fn whence(&self, ctx: &TldrContext) -> Option<String>;
+    fn how(&self, ctx: &TldrContext) -> Option<String>;
+}
+```
+
+### [`TldrSummary`]
+
+```rust
+pub struct TldrSummary {
+    pub who: Option<String>,
+    pub what: Option<String>,
+    pub when: Option<String>,
+    pub r#where: Option<String>,
+    pub why: Option<String>,
+    pub whence: Option<String>,
+    pub how: Option<String>,
+}
+```
+
+### [`TldrContext`]
+
+```rust
+pub struct TldrContext {
+    pub language: String,
+}
+```
+
 ## 👨‍💻 Development
 
 ```bash
@@ -46,4 +110,11 @@ git clone https://github.com/dryrust/tldr.rs.git
 [![Share on Facebook](https://img.shields.io/badge/share%20on-fb-1976D2?logo=facebook)](https://www.facebook.com/sharer/sharer.php?u=https://github.com/dryrust/tldr.rs)
 [![Share on LinkedIn](https://img.shields.io/badge/share%20on-linkedin-3949AB?logo=linkedin)](https://www.linkedin.com/sharing/share-offsite/?url=https://github.com/dryrust/tldr.rs)
 
+[Rust]: https://rust-lang.org
+[TL;DR]: https://en.wikipedia.org/wiki/TL;DR
 [naming conventions]: https://rust-lang.github.io/api-guidelines/naming.html
+
+[`Tldr`]: #
+[`TldrContext`]: #
+[`TldrSummary`]: #
+[`ToTldr`]: #

src/context.rs

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

src/lib.rs

@@ -10,3 +10,12 @@
 pub struct ReadmeDoctests;
 
 extern crate alloc;
+
+mod context;
+pub use context::*;
+
+mod summary;
+pub use summary::*;
+
+mod traits;
+pub use traits::*;

src/summary.rs

@@ -0,0 +1,66 @@
+// This is free and unencumbered software released into the public domain.
+
+use crate::{Tldr, TldrContext, ToTldr};
+use alloc::{boxed::Box, string::String};
+
+/// See: https://en.wikipedia.org/wiki/Five_Ws
+/// See: https://en.wikipedia.org/wiki/Interrogative_word
+#[derive(Clone, Debug)]
+pub struct TldrSummary {
+    /// See: https://en.wiktionary.org/wiki/who
+    pub who: Option<String>,
+
+    /// See: https://en.wiktionary.org/wiki/what
+    pub what: Option<String>,
+
+    /// See: https://en.wiktionary.org/wiki/when
+    pub when: Option<String>,
+
+    /// See: https://en.wiktionary.org/wiki/where
+    pub r#where: Option<String>,
+
+    /// See: https://en.wiktionary.org/wiki/why
+    pub why: Option<String>,
+
+    /// See: https://en.wiktionary.org/wiki/whence
+    pub whence: Option<String>,
+
+    /// See: https://en.wiktionary.org/wiki/how
+    pub how: Option<String>,
+}
+
+impl ToTldr for TldrSummary {
+    fn to_tldr(&self) -> Box<dyn Tldr> {
+        Box::new(self.clone())
+    }
+}
+
+impl Tldr for TldrSummary {
+    fn who(&self, _ctx: &TldrContext) -> Option<String> {
+        self.who.clone()
+    }
+
+    fn what(&self, _ctx: &TldrContext) -> Option<String> {
+        self.what.clone()
+    }
+
+    fn when(&self, _ctx: &TldrContext) -> Option<String> {
+        self.when.clone()
+    }
+
+    fn r#where(&self, _ctx: &TldrContext) -> Option<String> {
+        self.r#where.clone()
+    }
+
+    fn why(&self, _ctx: &TldrContext) -> Option<String> {
+        self.why.clone()
+    }
+
+    fn whence(&self, _ctx: &TldrContext) -> Option<String> {
+        self.whence.clone()
+    }
+
+    fn how(&self, _ctx: &TldrContext) -> Option<String> {
+        self.how.clone()
+    }
+}

src/traits.rs

@@ -0,0 +1,7 @@
+// This is free and unencumbered software released into the public domain.
+
+mod tldr;
+pub use tldr::*;
+
+mod to_tldr;
+pub use to_tldr::*;

src/traits/tldr.rs

@@ -0,0 +1,43 @@
+// This is free and unencumbered software released into the public domain.
+
+use crate::TldrContext;
+use alloc::string::String;
+
+/// See: https://en.wikipedia.org/wiki/Five_Ws
+/// See: https://en.wikipedia.org/wiki/Interrogative_word
+pub trait Tldr {
+    /// See: https://en.wiktionary.org/wiki/who
+    fn who(&self, _ctx: &TldrContext) -> Option<String> {
+        None
+    }
+
+    /// See: https://en.wiktionary.org/wiki/what
+    fn what(&self, _ctx: &TldrContext) -> Option<String> {
+        None
+    }
+
+    /// See: https://en.wiktionary.org/wiki/when
+    fn when(&self, _ctx: &TldrContext) -> Option<String> {
+        None
+    }
+
+    /// See: https://en.wiktionary.org/wiki/where
+    fn r#where(&self, _ctx: &TldrContext) -> Option<String> {
+        None
+    }
+
+    /// See: https://en.wiktionary.org/wiki/why
+    fn why(&self, _ctx: &TldrContext) -> Option<String> {
+        None
+    }
+
+    /// See: https://en.wiktionary.org/wiki/whence
+    fn whence(&self, _ctx: &TldrContext) -> Option<String> {
+        None
+    }
+
+    /// See: https://en.wiktionary.org/wiki/how
+    fn how(&self, _ctx: &TldrContext) -> Option<String> {
+        None
+    }
+}

src/traits/to_tldr.rs

@@ -0,0 +1,8 @@
+// This is free and unencumbered software released into the public domain.
+
+use crate::Tldr;
+use alloc::boxed::Box;
+
+pub trait ToTldr {
+    fn to_tldr(&self) -> Box<dyn Tldr>;
+}