Struct TldrSummary

pub struct TldrSummary<T: Clone + Debug + Default = String> {
    pub who: Option<T>,
    pub what: Option<T>,
    pub when: Option<T>,
    pub where: Option<T>,
    pub why: Option<T>,
    pub whence: Option<T>,
    pub how: Option<T>,
}

An owned TL;DR summary.

Examples

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: en.wikipedia.org/wiki/Five_Ws

See: en.wikipedia.org/wiki/Interrogative_word

Fields

who: Option<T>

Answers the question “Who?”

See: en.wiktionary.org/wiki/who

what: Option<T>

Answers the question “What?”

See: en.wiktionary.org/wiki/what

when: Option<T>

Answers the question “When?”

See: en.wiktionary.org/wiki/when

where: Option<T>

Answers the question “Where?”

See: en.wiktionary.org/wiki/where

why: Option<T>

Answers the question “Why?”

See: en.wiktionary.org/wiki/why

whence: Option<T>

Answers the question “Whence?” (i.e., “From where?”)

See: en.wiktionary.org/wiki/whence

how: Option<T>

Answers the question “How?”

See: en.wiktionary.org/wiki/how

Implementations

impl<T: Clone + Debug + Default> TldrSummary<T>

pub fn builder() -> TldrSummaryBuilder<T>

Create an instance of TldrSummary using the builder syntax

Trait Implementations

impl<T: Clone + Clone + Debug + Default> Clone for TldrSummary<T>

fn clone(&self) -> TldrSummary<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Clone + Debug + Default> Debug for TldrSummary<T>

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

Formats the value using the given formatter.

impl<T: Default + Clone + Debug + Default> Default for TldrSummary<T>

fn default() -> TldrSummary<T>

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for TldrSummary<T>

where TldrSummary<T>: Default, T: Deserialize<'de> + Clone + Debug + Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Serialize for TldrSummary<T>

where T: Serialize + Clone + Debug + Default,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Clone + Debug + Default> Tldr<T> for TldrSummary<T>

type Error = ()

The associated error type.

fn who(&self, _ctx: &TldrContext) -> TldrResult<T, Self::Error>

Answers the question “Who?”

fn what(&self, _ctx: &TldrContext) -> TldrResult<T, Self::Error>

Answers the question “What?”

fn when(&self, _ctx: &TldrContext) -> TldrResult<T, Self::Error>

Answers the question “When?”

fn where(&self, _ctx: &TldrContext) -> TldrResult<T, Self::Error>

Answers the question “Where?”

fn why(&self, _ctx: &TldrContext) -> TldrResult<T, Self::Error>

Answers the question “Why?”

fn whence(&self, _ctx: &TldrContext) -> TldrResult<T, Self::Error>

Answers the question “Whence?” (i.e., “From where?”)

fn how(&self, _ctx: &TldrContext) -> TldrResult<T, Self::Error>

Answers the question “How?”

impl<T: Clone + Debug + Default + 'static> ToTldr<T> for TldrSummary<T>

type Error = ()

The associated error type.

fn to_tldr(&self) -> Box<dyn Tldr<T, Error = Self::Error>>