Struct Stat 

pub struct Stat<S = String> {
    pub entity: S,
    pub max: Option<S>,
    pub caption: Option<S>,
}

Displays an MXP entity value as status bar text.

See MXP specification: <STAT>.

Examples

use mxp::RgbColor;

assert_eq!(
    "<Stat Hp MAX=HpMax CAPTION=Health>".parse::<mxp::Stat>(),
    Ok(mxp::Stat {
        entity: "Hp".into(),
        max: Some("HpMax".into()),
        caption: Some("Health".into()),
    }),
);

Fields

entity: S

Name of the entity to use as text data.

max: Option<S>

Name of the entity to use for the maximum value of the data.

caption: Option<S>

Optional caption text.

Implementations

impl<S> Stat<S>

pub fn map_text<T, F>(self, f: F) -> Stat<T>

where F: FnMut(S) -> T,

Applies a type transformation to all text, returning a new struct.

impl<S: IntoOwnedString> Stat<S>

pub fn into_owned(self) -> Stat<String>

impl<S: AsRef<str>> Stat<S>

pub fn borrow_text(&self) -> Stat<&str>

Returns a new struct that borrows text from this one.

Trait Implementations

impl<S: Clone> Clone for Stat<S>

fn clone(&self) -> Stat<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for Stat<S>

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

Formats the value using the given formatter.

impl<S: Default> Default for Stat<S>

fn default() -> Stat<S>

Returns the “default value” for a type.

impl<S: AsRef<str>> Display for Stat<S>

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

Formats the value using the given formatter.

impl FromStr for Stat

type Err = FromStrError

The associated error which can be returned from parsing.

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

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

impl PartialEq<Stat<&str>> for Stat<String>

fn eq(&self, other: &Stat<&str>) -> 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 PartialEq<Stat<&str>> for Stat<Cow<'_, str>>

fn eq(&self, other: &Stat<&str>) -> 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 PartialEq<Stat<Cow<'_, str>>> for Stat<String>

fn eq(&self, other: &Stat<Cow<'_, str>>) -> 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 PartialEq<Stat<Cow<'_, str>>> for Stat<&str>

fn eq(&self, other: &Stat<Cow<'_, str>>) -> 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 PartialEq<Stat> for Stat<&str>

fn eq(&self, other: &Stat<String>) -> 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 PartialEq<Stat> for Stat<Cow<'_, str>>

fn eq(&self, other: &Stat<String>) -> 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<S: PartialEq> PartialEq for Stat<S>

fn eq(&self, other: &Stat<S>) -> 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<'a> TryFrom<&'a str> for Stat<Cow<'a, str>>

type Error = FromStrError

The type returned in the event of a conversion error.

fn try_from(s: &'a str) -> Result<Self, Self::Error>

Performs the conversion.

impl<S: Copy> Copy for Stat<S>

impl<S: Eq> Eq for Stat<S>

impl<S> StructuralPartialEq for Stat<S>