Struct Text

pub struct Text {
    pub years: ThresholdMap<String>,
    pub months: ThresholdMap<String>,
    pub weeks: ThresholdMap<String>,
    pub days: ThresholdMap<String>,
    pub hours: ThresholdMap<String>,
    pub minutes: ThresholdMap<String>,
    pub seconds: ThresholdMap<String>,
    pub joiner: String,
    pub final_joiner: Option<String>,
    pub spacer: String,
}

All the strings that may be used to compose the final output. This owns the Strings, so if it’s performance-sensitive, you will want to reuse an instance of Text.

Each of the units uses a ThresholdMap<String>, which allows you to have different text for different counts, like for implementing plurals.

By default, joiner, final_joiner and spacer are ", ", Some(" and ") and " ", respectively (except Strings).

Fields

years: ThresholdMap<String>

months: ThresholdMap<String>

weeks: ThresholdMap<String>

days: ThresholdMap<String>

hours: ThresholdMap<String>

minutes: ThresholdMap<String>

seconds: ThresholdMap<String>

joiner: String

In "14 days[, ]6 hours and 56 minutes", the bracketed part.

final_joiner: Option<String>

In "14 days, 6 hours[ and ]56 minutes", the bracketed part. If none, it will use the regular joiner.

spacer: String

In "14[ ]days, 6[ ]hours and 56[ ]minutes", the bracketed parts.

Trait Implementations

impl Clone for Text

fn clone(&self) -> Text

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Text

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

Formats the value using the given formatter.

impl Default for Text

fn default() -> Self

Returns the “default value” for a type.