Crate tldr_traits

Source
Expand description

This crate provides abstractions for TL;DR summarization using the five Ws:

The Five Ws is a checklist used in journalism to ensure that the lead contains all the essential points of a story. As far back as 1913, reporters were taught that the lead should answer these questions:

  • Who? – asking about a person or other agent
  • What? – asking about an object or action
  • When? – asking about a time
  • Where? – asking about a place
  • Why? – asking about a reason or cause

In modern times, journalism students are still taught that these are the fundamental five questions of newswriting.

§Examples

use tldr::{Tldr, TldrContext, TldrLanguage, TldrResult, TldrSummary, ToTldr};

Structs§

TldrContext
A context used when generating TL;DR summaries.
TldrContextBuilder
Use builder syntax to set the inputs and finish with build().
TldrSummary
An owned TL;DR summary.
TldrSummaryBuilder
Use builder syntax to set the inputs and finish with build().

Enums§

TldrLanguage
The language that a TL;DR summary is written in.

Traits§

Tldr
A trait for generating a TL;DR summary.
ToTldr
A trait for converting objects into TL;DR summaries.

Type Aliases§

TldrResult
The result type used throughout the library.