Struct TldrContext

#[non_exhaustive]
pub struct TldrContext {
    pub language: TldrLanguage,
}

A context used when generating TL;DR summaries.

Examples

let context = TldrContext::builder()
    .language("en")
    .build();

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

language: TldrLanguage

The language to use when generating TL;DR summaries.

Implementations

impl TldrContext

pub fn builder() -> TldrContextBuilder

Create an instance of TldrContext using the builder syntax

Trait Implementations

impl Clone for TldrContext

fn clone(&self) -> TldrContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TldrContext

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

Formats the value using the given formatter.

impl Default for TldrContext

fn default() -> TldrContext

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TldrContext

where TldrContext: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromStr for TldrContext

type Err = ()

The associated error which can be returned from parsing.

fn from_str(input: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for TldrContext

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for TldrContext

fn eq(&self, other: &TldrContext) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for TldrContext

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for TldrContext

impl StructuralPartialEq for TldrContext