Struct cardpack::fluent::fluent_name::FluentName

pub struct FluentName(_);

FluentName is the primary implementation of the Named trait.

FluentName represents the fluent template key for a card entity such as a Suit or Rank, which in turn determines its long name in any represented language, the short letter used to display an index, and the default weight for the if it is instantiated via ::new(). A FluentName must have a corresponding entries in the fluent templates for weight, long, and index.

Implementations

impl FluentName

pub fn new(name: &'static str) -> FluentName

Trait Implementations

impl Clone for FluentName

fn clone(&self) -> FluentName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for FluentName

impl Debug for FluentName

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

Formats the value using the given formatter.

impl Default for FluentName

fn default() -> FluentName

Returns the "default value" for a type.

impl Display for FluentName

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

Formats the value using the given formatter.

impl Eq for FluentName

impl Hash for FluentName

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, 

Feeds a slice of this type into the given Hasher.

impl Named for FluentName

fn name(&self) -> &str

fn fluent_value(&self, key_section: &str, lid: &LanguageIdentifier) -> String

This is the core method for getting fluent values. the index, long, and default weight methods are all just methods simplifying the call to this method.

fn index(&self, lid: &LanguageIdentifier) -> String

Returns the value of the names' index in the fluent templates.

fn index_default(&self) -> String

Returns the default, US_ENGLISH value of the names' index value in the fluent templates.

fn long(&self, lid: &LanguageIdentifier) -> String

Returns the value of the names' long value in the fluent templates.

fn long_default(&self) -> String

Returns the default, US_ENGLISH value of the names' long value in the fluent templates.

fn default_weight(&self) -> isize

Returns the default weight for a name. Weight is used to sort cards.

impl Ord for FluentName

fn cmp(&self, other: &FluentName) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<FluentName> for FluentName

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<FluentName> for FluentName

fn partial_cmp(&self, other: &FluentName) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &FluentName) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &FluentName) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &FluentName) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &FluentName) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for FluentName

impl StructuralPartialEq for FluentName